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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.104 by root, Wed Jan 18 17:49:47 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.
		93
		94	Other extensions can extend this popup menu by pushing a code reference onto
		95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
		96
		97	It's sole argument is the popup menu, which can be modified. The selection
		98	is in C<$_>, which can be used to decide wether to add something or not.
		99	It should either return nothing or a string and a code reference. The
		100	string will be used as button text and the code reference will be called
		101	when the button gets activated and should transform C<$_>.
		102
		103	The following will add an entry C<a to b> that transforms all C<a>s in
		104	the selection to C<b>s, but only if the selection currently contains any
		105	C<a>s:
		106
		107	push urxvt::ext::selection_popup::hook, sub {
		108	/a/ ? ("a to be" => sub { s/a/b/g }
		109	: ()
		110	};
70		111
71	=item searchable-scrollback<hotkey> (enabled by default)	112	=item searchable-scrollback<hotkey> (enabled by default)
72		113
73	Adds regex search functionality to the scrollback buffer, triggered	114	Adds regex search functionality to the scrollback buffer, triggered
74	by a hotkey (default: C<M-s>). When in search mode, normal terminal	115	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	input/output is suspended.	116	input/output is suspended and a regex is displayed at the bottom of the
		117	screen.
76		118
77	C</> starts an incremental regex search, C<n> searches further, C<p> or	119	Inputting characters appends them to the regex and continues incremental
78	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	120	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
79	history, C<enter> leaves search mode at the current position and C<escape>	121	search upwards/downwards in the scrollback buffer, C<End> jumps to the
80	returns to the original position.	122	bottom. C<Escape> leaves search mode and returns to the point where search
		123	was started, while C<Enter> or C<Return> stay at the current position and
		124	additionally stores the first match in the current line into the primary
		125	selection.
81		126
82	=item digital-clock	127	=item selection-autotransform
83		128
84	Displays a digital clock using the built-in overlay.	129	This selection allows you to do automatic transforms on a selection
		130	whenever a selection is made.
		131
		132	It works by specifying perl snippets (most useful is a single C<s///>
		133	operator) that modify C<$_> as resources:
		134
		135	URxvt.selection-autotransform.0: transform
		136	URxvt.selection-autotransform.1: transform
		137	...
		138
		139	For example, the following will transform selections of the form
		140	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		141	$word>:
		142
		143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		144
		145	And this example matches the same,but replaces it with vi-commands you can
		146	paste directly into your (vi :) editor:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		149
		150	Of course, this can be modified to suit your needs and your editor :)
		151
		152	To expand the example above to typical perl error messages ("XXX at
		153	FILENAME line YYY."), you need a slightly more elaborate solution:
		154
		155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		157
		158	The first line tells the selection code to treat the unchanging part of
		159	every error message as a selection pattern, and the second line transforms
		160	the message into vi commands to load the file.
85		161
86	=item mark-urls	162	=item mark-urls
87		163
88	Uses per-line display filtering (C<on_line_update>) to underline urls.	164	Uses per-line display filtering (C<on_line_update>) to underline urls and
		165	make them clickable. When middle-clicked, the program specified in the
		166	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		167	the URL as first argument.
		168
		169	=item automove-background
		170
		171	This is basically a one-line extension that dynamically changes the background pixmap offset
		172	to the window position, in effect creating the same effect as pseudo transparency with
		173	a custom pixmap. No scaling is supported in this mode. Exmaple:
		174
		175	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
89		176
90	=item block-graphics-to-ascii	177	=item block-graphics-to-ascii
91		178
92	A not very useful example of filtering all text output to the terminal,	179	A not very useful example of filtering all text output to the terminal,
93	by replacing all line-drawing characters (U+2500 .. U+259F) by a	180	by replacing all line-drawing characters (U+2500 .. U+259F) by a
94	similar-looking ascii character.	181	similar-looking ascii character.
95		182
		183	=item digital-clock
		184
		185	Displays a digital clock using the built-in overlay.
		186
96	=item example-refresh-hooks	187	=item example-refresh-hooks
97		188
98	Displays a very simple digital clock in the upper right corner of the	189	Displays a very simple digital clock in the upper right corner of the
99	window. Illustrates overwriting the refresh callbacks to create your own	190	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	191	overlays or changes.
101		192
		193	=item selection-pastebin
		194
		195	This is a little rarely useful extension that Uploads the selection as
		196	textfile to a remote site (or does other things). (The implementation is
		197	not currently secure for use in a multiuser environment as it writes to
		198	F</tmp> directly.).
		199
		200	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		201	i.e.
		202
		203	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		204
		205	Pressing this combination runs a command with C<%> replaced by the name of
		206	the textfile. This command can be set via a resource:
		207
		208	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		209
		210	And the default is likely not useful to anybody but the few people around
		211	here :)
		212
		213	The name of the textfile is the hex encoded md5 sum of the selection, so
		214	the same content should lead to the same filename.
		215
		216	After a successful upload the selection will be replaced by the text given
		217	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		218	for the filename):
		219
		220	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		221
102	=back	222	=back
		223
		224	=head1 API DOCUMENTATION
103		225
104	=head2 General API Considerations	226	=head2 General API Considerations
105		227
106	All objects (such as terminals, time watchers etc.) are typical	228	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	229	reference-to-hash objects. The hash can be used to store anything you
…		…
120	=over 4	242	=over 4
121		243
122	=item $text	244	=item $text
123		245
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	246	Rxvt-unicodes special way of encoding text, where one "unicode" character
125	always represents one screen cell. See L<row_t> for a discussion of this format.	247	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		248
127	=item $string	249	=item $string
128		250
129	A perl text string, with an emphasis on I<text>. It can store all unicode	251	A perl text string, with an emphasis on I<text>. It can store all unicode
130	characters and is to be distinguished with text encoded in a specific	252	characters and is to be distinguished with text encoded in a specific
…		…
225	=item on_sel_extend $term	347	=item on_sel_extend $term
226		348
227	Called whenever the user tries to extend the selection (e.g. with a double	349	Called whenever the user tries to extend the selection (e.g. with a double
228	click) and is either supposed to return false (normal operation), or	350	click) and is either supposed to return false (normal operation), or
229	should extend the selection itelf and return true to suppress the built-in	351	should extend the selection itelf and return true to suppress the built-in
230	processing.	352	processing. This can happen multiple times, as long as the callback
		353	returns true, it will be called on every further click by the user and is
		354	supposed to enlarge the selection more and more, if possible.
231		355
232	See the F<selection> example extension.	356	See the F<selection> example extension.
233		357
234	=item on_view_change $term, $offset	358	=item on_view_change $term, $offset
235		359
…		…
302		426
303	Called whenever the user presses a key combination that has a	427	Called whenever the user presses a key combination that has a
304	C<perl:string> action bound to it (see description of the B<keysym>	428	C<perl:string> action bound to it (see description of the B<keysym>
305	resource in the @@RXVT_NAME@@(1) manpage).	429	resource in the @@RXVT_NAME@@(1) manpage).
306		430
		431	=item on_x_event $term, $event
		432
		433	Called on every X event received on the vt window (and possibly other
		434	windows). Should only be used as a last resort. Most event structure
		435	members are not passed.
		436
307	=item on_focus_in $term	437	=item on_focus_in $term
308		438
309	Called whenever the window gets the keyboard focus, before rxvt-unicode	439	Called whenever the window gets the keyboard focus, before rxvt-unicode
310	does focus in processing.	440	does focus in processing.
311		441
312	=item on_focus_out $term	442	=item on_focus_out $term
313		443
314	Called wheneever the window loses keyboard focus, before rxvt-unicode does	444	Called wheneever the window loses keyboard focus, before rxvt-unicode does
315	focus out processing.	445	focus out processing.
		446
		447	=item on_configure_notify $term, $event
316		448
317	=item on_key_press $term, $event, $keysym, $octets	449	=item on_key_press $term, $event, $keysym, $octets
318		450
319	=item on_key_release $term, $event, $keysym	451	=item on_key_release $term, $event, $keysym
320		452
…		…
337		469
338	C<on_key_press> additionally receives the string rxvt-unicode would	470	C<on_key_press> additionally receives the string rxvt-unicode would
339	output, if any, in locale-specific encoding.	471	output, if any, in locale-specific encoding.
340		472
341	subwindow.	473	subwindow.
342
343	=back
344
345	=head2 Variables in the C<urxvt> Package
346
347	=over 4
348
349	=item $urxvt::TERM
350
351	The current terminal. This variable stores the current C<urxvt::term>
352	object, whenever a callback/hook is executing.
353
354	=back
355
356	=head2 Functions in the C<urxvt> Package
357
358	=over 4
359
360	=item $term = new urxvt [arg...]
361
362	Creates a new terminal, very similar as if you had started it with
363	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
364	if the new instance couldn't be created. Returns C<undef> if the new
365	instance didn't initialise perl, and the terminal object otherwise. The
366	C<init> and C<start> hooks will be called during the call.
367
368	=item urxvt::fatal $errormessage
369
370	Fatally aborts execution with the given error message. Avoid at all
371	costs! The only time this is acceptable is when the terminal process
372	starts up.
373
374	=item urxvt::warn $string
375
376	Calls C<rxvt_warn> with the given string which should not include a
377	newline. The module also overwrites the C<warn> builtin with a function
378	that calls this function.
379
380	Using this function has the advantage that its output ends up in the
381	correct place, e.g. on stderr of the connecting urxvtc client.
382
383	=item $is_safe = urxvt::safe
384
385	Returns true when it is safe to do potentially unsafe things, such as
386	evaluating perl code specified by the user. This is true when urxvt was
387	started setuid or setgid.
388
389	=item $time = urxvt::NOW
390
391	Returns the "current time" (as per the event loop).
392
393	=item urxvt::CurrentTime
394
395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
397	Button4Mask, Button5Mask, AnyModifier
398
399	Various constants for use in X calls and event processing.
400
401	=back
402
403	=head2 RENDITION
404
405	Rendition bitsets contain information about colour, font, font styles and
406	similar information for each screen cell.
407
408	The following "macros" deal with changes in rendition sets. You should
409	never just create a bitset, you should always modify an existing one,
410	as they contain important information required for correct operation of
411	rxvt-unicode.
412
413	=over 4
414
415	=item $rend = urxvt::DEFAULT_RSTYLE
416
417	Returns the default rendition, as used when the terminal is starting up or
418	being reset. Useful as a base to start when creating renditions.
419
420	=item $rend = urxvt::OVERLAY_RSTYLE
421
422	Return the rendition mask used for overlays by default.
423
424	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
425
426	Return the bit that enabled bold, italic, blink, reverse-video and
427	underline, respectively. To enable such a style, just logically OR it into
428	the bitset.
429
430	=item $foreground = urxvt::GET_BASEFG $rend
431
432	=item $background = urxvt::GET_BASEBG $rend
433
434	Return the foreground/background colour index, respectively.
435
436	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
437
438	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
439
440	Replace the foreground/background colour in the rendition mask with the
441	specified one.
442
443	=item $value = urxvt::GET_CUSTOM ($rend)
444
445	Return the "custom" value: Every rendition has 5 bits for use by
446	extensions. They can be set and changed as you like and are initially
447	zero.
448
449	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
450
451	Change the custom value.
452		474
453	=back	475	=back
454		476
455	=cut	477	=cut
456		478
…		…
471	our $LIBDIR;	493	our $LIBDIR;
472	our $RESNAME;	494	our $RESNAME;
473	our $RESCLASS;	495	our $RESCLASS;
474	our $RXVTNAME;	496	our $RXVTNAME;
475		497
		498	=head2 Variables in the C<urxvt> Package
		499
		500	=over 4
		501
		502	=item $urxvt::LIBDIR
		503
		504	The rxvt-unicode library directory, where, among other things, the perl
		505	modules and scripts are stored.
		506
		507	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		508
		509	The resource class and name rxvt-unicode uses to look up X resources.
		510
		511	=item $urxvt::RXVTNAME
		512
		513	The basename of the installed binaries, usually C<urxvt>.
		514
		515	=item $urxvt::TERM
		516
		517	The current terminal. This variable stores the current C<urxvt::term>
		518	object, whenever a callback/hook is executing.
		519
		520	=back
		521
		522	=head2 Functions in the C<urxvt> Package
		523
		524	=over 4
		525
		526	=item urxvt::fatal $errormessage
		527
		528	Fatally aborts execution with the given error message. Avoid at all
		529	costs! The only time this is acceptable is when the terminal process
		530	starts up.
		531
		532	=item urxvt::warn $string
		533
		534	Calls C<rxvt_warn> with the given string which should not include a
		535	newline. The module also overwrites the C<warn> builtin with a function
		536	that calls this function.
		537
		538	Using this function has the advantage that its output ends up in the
		539	correct place, e.g. on stderr of the connecting urxvtc client.
		540
		541	Messages have a size limit of 1023 bytes currently.
		542
		543	=item $time = urxvt::NOW
		544
		545	Returns the "current time" (as per the event loop).
		546
		547	=item urxvt::CurrentTime
		548
		549	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		550	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		551	Button4Mask, Button5Mask, AnyModifier
		552
		553	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		554	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		555	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		556	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		557	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		558	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		559	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		560
		561	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		562	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		563	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		564	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		565	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		566	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		567	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		568
		569	Various constants for use in X calls and event processing.
		570
		571	=back
		572
		573	=head2 RENDITION
		574
		575	Rendition bitsets contain information about colour, font, font styles and
		576	similar information for each screen cell.
		577
		578	The following "macros" deal with changes in rendition sets. You should
		579	never just create a bitset, you should always modify an existing one,
		580	as they contain important information required for correct operation of
		581	rxvt-unicode.
		582
		583	=over 4
		584
		585	=item $rend = urxvt::DEFAULT_RSTYLE
		586
		587	Returns the default rendition, as used when the terminal is starting up or
		588	being reset. Useful as a base to start when creating renditions.
		589
		590	=item $rend = urxvt::OVERLAY_RSTYLE
		591
		592	Return the rendition mask used for overlays by default.
		593
		594	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		595
		596	Return the bit that enabled bold, italic, blink, reverse-video and
		597	underline, respectively. To enable such a style, just logically OR it into
		598	the bitset.
		599
		600	=item $foreground = urxvt::GET_BASEFG $rend
		601
		602	=item $background = urxvt::GET_BASEBG $rend
		603
		604	Return the foreground/background colour index, respectively.
		605
		606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		607
		608	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		609
		610	Replace the foreground/background colour in the rendition mask with the
		611	specified one.
		612
		613	=item $value = urxvt::GET_CUSTOM $rend
		614
		615	Return the "custom" value: Every rendition has 5 bits for use by
		616	extensions. They can be set and changed as you like and are initially
		617	zero.
		618
		619	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		620
		621	Change the custom value.
		622
		623	=back
		624
		625	=cut
		626
476	BEGIN {	627	BEGIN {
477	urxvt->bootstrap;
478
479	# overwrite perl's warn	628	# overwrite perl's warn
480	*CORE::GLOBAL::warn = sub {	629	*CORE::GLOBAL::warn = sub {
481	my $msg = join "", @_;	630	my $msg = join "", @_;
482	$msg .= "\n"	631	$msg .= "\n"
483	unless $msg =~ /\n$/;	632	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	633	urxvt::warn ($msg);
485	};	634	};
486		635
		636	# %ENV is the original startup environment
487	delete $ENV{IFS};	637	delete $ENV{IFS};
488	delete $ENV{CDPATH};	638	delete $ENV{CDPATH};
489	delete $ENV{BASH_ENV};	639	delete $ENV{BASH_ENV};
490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	640	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
491	}	641	}
492		642
493	my @hook_count;
494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	643	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495		644
496	sub verbose {	645	sub verbose {
497	my ($level, $msg) = @_;	646	my ($level, $msg) = @_;
498	warn "$msg\n" if $level <= $verbosity;	647	warn "$msg\n" if $level <= $verbosity;
499	}	648	}
500		649
501	my $extension_pkg = "extension0000";
502	my %extension_pkg;	650	my %extension_pkg;
503		651
504	# load a single script into its own package, once only	652	# load a single script into its own package, once only
505	sub extension_package($) {	653	sub extension_package($) {
506	my ($path) = @_;	654	my ($path) = @_;
507		655
		656	no strict 'refs';
		657
508	$extension_pkg{$path} \|\|= do {	658	$extension_pkg{$path} \|\|= do {
509	my $pkg = "urxvt::" . ($extension_pkg++);	659	$path =~ /([^\/\\]+)$/;
		660	my $pkg = $1;
		661	$pkg =~ s/[^[:word:]]/_/g;
		662	$pkg = "urxvt::ext::$pkg";
510		663
511	verbose 3, "loading extension '$path' into package '$pkg'";	664	verbose 3, "loading extension '$path' into package '$pkg'";
512		665
513	open my $fh, "<:raw", $path	666	open my $fh, "<:raw", $path
514	or die "$path: $!";	667	or die "$path: $!";
515		668
		669	@{"$pkg\::ISA"} = urxvt::term::extension::;
		670
516	my $source = untaint	671	my $source =
517	"package $pkg; use strict; use utf8;\n"	672	"package $pkg; use strict; use utf8;\n"
518	. "use base urxvt::term::extension::;\n"
519	. "#line 1 \"$path\"\n{\n"	673	. "#line 1 \"$path\"\n{\n"
520	. (do { local $/; <$fh> })	674	. (do { local $/; <$fh> })
521	. "\n};\n1";	675	. "\n};\n1";
522		676
523	eval $source	677	eval $source
…		…
580	if ($@) {	734	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	735	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	736	warn $@;
583	}	737	}
584	}	738	}
		739
		740	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		741	if $verbosity >= 11;
585	}	742	}
586		743
587	if ($htype == 1) { # DESTROY	744	if ($htype == 1) { # DESTROY
588	if (my $hook = delete $TERM->{_hook}) {
589	for my $htype (0..$#$hook) {
590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
591	or set_should_invoke $htype, 0;
592	}
593	}
594
595	# clear package objects	745	# clear package objects
596	%$_ = () for values %{ $TERM->{_pkg} };	746	%$_ = () for values %{ $TERM->{_pkg} };
597		747
598	# clear package	748	# clear package
599	%$TERM = ();	749	%$TERM = ();
600	}	750	}
601		751
602	$retval	752	$retval
		753	}
		754
		755	sub exec_async(@) {
		756	my $pid = fork;
		757
		758	return
		759	if !defined $pid or $pid;
		760
		761	%ENV = %{ $TERM->env };
		762
		763	exec @_;
		764	_exit 255;
603	}	765	}
604		766
605	# urxvt::term::extension	767	# urxvt::term::extension
606		768
607	package urxvt::term::extension;	769	package urxvt::term::extension;
…		…
613	while (my ($name, $cb) = each %hook) {	775	while (my ($name, $cb) = each %hook) {
614	my $htype = $HOOKTYPE{uc $name};	776	my $htype = $HOOKTYPE{uc $name};
615	defined $htype	777	defined $htype
616	or Carp::croak "unsupported hook type '$name'";	778	or Carp::croak "unsupported hook type '$name'";
617		779
		780	$self->set_should_invoke ($htype, +1)
618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	781	unless exists $self->{term}{_hook}[$htype]{$pkg};
619	$hook_count[$htype]++
620	or urxvt::set_should_invoke $htype, 1;
621	}
622		782
623	$self->{term}{_hook}[$htype]{$pkg} = $cb;	783	$self->{term}{_hook}[$htype]{$pkg} = $cb;
624	}	784	}
625	}	785	}
626		786
…		…
631	for my $name (@hook) {	791	for my $name (@hook) {
632	my $htype = $HOOKTYPE{uc $name};	792	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	793	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	794	or Carp::croak "unsupported hook type '$name'";
635		795
		796	$self->set_should_invoke ($htype, -1)
636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	797	if delete $self->{term}{_hook}[$htype]{$pkg};
637	--$hook_count[$htype]
638	or urxvt::set_should_invoke $htype, 0;
639	}
640	}	798	}
641	}	799	}
642		800
643	our $AUTOLOAD;	801	our $AUTOLOAD;
644		802
…		…
675		833
676	=head2 The C<urxvt::anyevent> Class	834	=head2 The C<urxvt::anyevent> Class
677		835
678	The sole purpose of this class is to deliver an interface to the	836	The sole purpose of this class is to deliver an interface to the
679	C<AnyEvent> module - any module using it will work inside urxvt without	837	C<AnyEvent> module - any module using it will work inside urxvt without
680	further work. The only exception is that you cannot wait on condition	838	further programming. The only exception is that you cannot wait on
681	variables, but non-blocking condvar use is ok. What this means is that you	839	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	840	is that you cannot use blocking APIs, but the non-blocking variant should
		841	work.
683		842
684	=cut	843	=cut
685		844
686	our $VERSION = 1;	845	our $VERSION = 1;
687		846
…		…
764	$proxy->enable ($name => $ref);	923	$proxy->enable ($name => $ref);
765	}	924	}
766	}	925	}
767	}	926	}
768		927
		928	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		929
		930	Creates a new terminal, very similar as if you had started it with system
		931	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		932	hash which defines the environment of the new terminal.
		933
		934	Croaks (and probably outputs an error message) if the new instance
		935	couldn't be created. Returns C<undef> if the new instance didn't
		936	initialise perl, and the terminal object otherwise. The C<init> and
		937	C<start> hooks will be called during this call.
		938
		939	=cut
		940
		941	sub new {
		942	my ($class, $env, @args) = @_;
		943
		944	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		945	}
		946
769	=item $term->destroy	947	=item $term->destroy
770		948
771	Destroy the terminal object (close the window, free resources etc.).	949	Destroy the terminal object (close the window, free resources
		950	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		951	watchers (timers, io watchers) are still active.
772		952
773	=item $isset = $term->option ($optval[, $set])	953	=item $isset = $term->option ($optval[, $set])
774		954
775	Returns true if the option specified by C<$optval> is enabled, and	955	Returns true if the option specified by C<$optval> is enabled, and
776	optionally change it. All option values are stored by name in the hash	956	optionally change it. All option values are stored by name in the hash
…		…
826	my ($self, $name) = (shift, shift);	1006	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1007	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	1008	&urxvt::term::_resource
829	}	1009	}
830		1010
		1011	=item $value = $term->x_resource ($pattern)
		1012
		1013	Returns the X-Resource for the given pattern, excluding the program or
		1014	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1015	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1016	resource with that pattern exists.
		1017
		1018	This method should only be called during the C<on_start> hook, as there is
		1019	only one resource database per display, and later invocations might return
		1020	the wrong resources.
		1021
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1022	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		1023
833	Adds a keymap translation exactly as specified via a resource. See the	1024	Adds a keymap translation exactly as specified via a resource. See the
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1025	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835		1026
…		…
850	=item ($row, $col) = $term->selection_end ([$row, $col])	1041	=item ($row, $col) = $term->selection_end ([$row, $col])
851		1042
852	Return the current values of the selection mark, begin or end positions,	1043	Return the current values of the selection mark, begin or end positions,
853	and optionally set them to new values.	1044	and optionally set them to new values.
854		1045
		1046	=item $term->selection_make ($eventtime[, $rectangular])
		1047
		1048	Tries to make a selection as set by C<selection_beg> and
		1049	C<selection_end>. If C<$rectangular> is true (default: false), a
		1050	rectangular selection will be made. This is the prefered function to make
		1051	a selection.
		1052
855	=item $success = $term->selection_grab ($eventtime)	1053	=item $success = $term->selection_grab ($eventtime)
856		1054
857	Try to request the primary selection from the server (for example, as set	1055	Try to request the primary selection text from the server (for example, as
858	by the next method).	1056	set by the next method). No visual feedback will be given. This function
		1057	is mostly useful from within C<on_sel_grab> hooks.
859		1058
860	=item $oldtext = $term->selection ([$newtext])	1059	=item $oldtext = $term->selection ([$newtext])
861		1060
862	Return the current selection text and optionally replace it by C<$newtext>.	1061	Return the current selection text and optionally replace it by C<$newtext>.
863		1062
…		…
956	Convert the given locale-encoded octets into a perl string.	1155	Convert the given locale-encoded octets into a perl string.
957		1156
958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1157	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959		1158
960	XORs the rendition values in the given span with the provided value	1159	XORs the rendition values in the given span with the provided value
961	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1160	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962	to the selection.	1161	refresh hooks to provide effects similar to the selection.
963		1162
964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1163	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965		1164
966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1165	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1166	whitespace will additionally be xored with the C<$rstyle2>, which defaults
968	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1167	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
969	it instead.	1168	it instead. Both styles I<MUST NOT> contain font styles.
970		1169
971	=item $term->scr_bell	1170	=item $term->scr_bell
972		1171
973	Ring the bell!	1172	Ring the bell!
974		1173
…		…
1008		1207
1009	=item $windowid = $term->vt	1208	=item $windowid = $term->vt
1010		1209
1011	Return the window id of the terminal window.	1210	Return the window id of the terminal window.
1012		1211
		1212	=item $term->vt_emask_add ($x_event_mask)
		1213
		1214	Adds the specified events to the vt event mask. Useful e.g. when you want
		1215	to receive pointer events all the times:
		1216
		1217	$term->vt_emask_add (urxvt::PointerMotionMask);
		1218
1013	=item $window_width = $term->width	1219	=item $window_width = $term->width
1014		1220
1015	=item $window_height = $term->height	1221	=item $window_height = $term->height
1016		1222
1017	=item $font_width = $term->fwidth	1223	=item $font_width = $term->fwidth
…		…
1030		1236
1031	=item $max_scrollback = $term->saveLines	1237	=item $max_scrollback = $term->saveLines
1032		1238
1033	=item $nrow_plus_saveLines = $term->total_rows	1239	=item $nrow_plus_saveLines = $term->total_rows
1034		1240
1035	=item $lines_in_scrollback = $term->nsaved	1241	=item $topmost_scrollback_row = $term->top_row
1036		1242
1037	Return various integers describing terminal characteristics.	1243	Return various integers describing terminal characteristics.
1038		1244
		1245	=item $x_display = $term->display_id
		1246
		1247	Return the DISPLAY used by rxvt-unicode.
		1248
1039	=item $lc_ctype = $term->locale	1249	=item $lc_ctype = $term->locale
1040		1250
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1251	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1252
1043	=item $x_display = $term->display_id	1253	=item $env = $term->env
1044		1254
1045	Return the DISPLAY used by rxvt-unicode.	1255	Returns a copy of the environment in effect for the terminal as a hashref
		1256	similar to C<\%ENV>.
		1257
		1258	=cut
		1259
		1260	sub env {
		1261	if (my $env = $_[0]->_env) {
		1262	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1263	} else {
		1264	+{ %ENV }
		1265	}
		1266	}
1046		1267
1047	=item $modifiermask = $term->ModLevel3Mask	1268	=item $modifiermask = $term->ModLevel3Mask
1048		1269
1049	=item $modifiermask = $term->ModMetaMask	1270	=item $modifiermask = $term->ModMetaMask
1050		1271
…		…
1053	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1274	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1054	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1275	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1055		1276
1056	=item $view_start = $term->view_start ([$newvalue])	1277	=item $view_start = $term->view_start ([$newvalue])
1057		1278
1058	Returns the negative row number of the topmost line. Minimum value is	1279	Returns the row number of the topmost displayed line. Maximum value is
1059	C<0>, which displays the normal terminal contents. Larger values scroll	1280	C<0>, which displays the normal terminal contents. Lower values scroll
1060	this many lines into the scrollback buffer.	1281	this many lines into the scrollback buffer.
1061		1282
1062	=item $term->want_refresh	1283	=item $term->want_refresh
1063		1284
1064	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1285	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1143	Return the row number of the first/last row of the line, respectively.	1364	Return the row number of the first/last row of the line, respectively.
1144		1365
1145	=item $offset = $line->offset_of ($row, $col)	1366	=item $offset = $line->offset_of ($row, $col)
1146		1367
1147	Returns the character offset of the given row\|col pair within the logical	1368	Returns the character offset of the given row\|col pair within the logical
1148	line.	1369	line. Works for rows outside the line, too, and returns corresponding
		1370	offsets outside the string.
1149		1371
1150	=item ($row, $col) = $line->coord_of ($offset)	1372	=item ($row, $col) = $line->coord_of ($offset)
1151		1373
1152	Translates a string offset into terminal coordinates again.	1374	Translates a string offset into terminal coordinates again.
1153		1375
…		…
1290	$item->{render} \|\|= sub { $_[0]{text} };	1512	$item->{render} \|\|= sub { $_[0]{text} };
1291		1513
1292	push @{ $self->{item} }, $item;	1514	push @{ $self->{item} }, $item;
1293	}	1515	}
1294		1516
		1517	=item $popup->add_title ($title)
		1518
		1519	Adds a non-clickable title to the popup.
		1520
		1521	=cut
		1522
		1523	sub add_title {
		1524	my ($self, $title) = @_;
		1525
		1526	$self->add_item ({
		1527	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1528	text => $title,
		1529	activate => sub { },
		1530	});
		1531	}
		1532
		1533	=item $popup->add_separator ([$sepchr])
		1534
		1535	Creates a separator, optionally using the character given as C<$sepchr>.
		1536
		1537	=cut
		1538
1295	sub add_separator {	1539	sub add_separator {
1296	my ($self, $sep) = @_;	1540	my ($self, $sep) = @_;
1297		1541
1298	$sep \|\|= "=";	1542	$sep \|\|= "=";
1299		1543
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1547	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1548	activate => sub { },
1305	});	1549	});
1306	}	1550	}
1307		1551
1308	sub add_title {	1552	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1553
1311	$self->add_item ({	1554	Adds a clickable button to the popup. C<$cb> is called whenever it is
1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1555	selected.
1313	text => $title,	1556
1314	activate => sub { },	1557	=cut
1315	});
1316	}
1317		1558
1318	sub add_button {	1559	sub add_button {
1319	my ($self, $text, $cb) = @_;	1560	my ($self, $text, $cb) = @_;
1320		1561
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1562	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	1563	}
		1564
		1565	=item $popup->add_toggle ($text, $cb, $initial_value)
		1566
		1567	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1568	whenever it gets toggled, with a boolean indicating its value as its first
		1569	argument.
		1570
		1571	=cut
1323		1572
1324	sub add_toggle {	1573	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1574	my ($self, $text, $cb, $value) = @_;
1326		1575
1327	my $item; $item = {	1576	my $item; $item = {
1328	type => "button",	1577	type => "button",
1329	text => " $text",	1578	text => " $text",
1330	value => $value,	1579	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1580	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1581	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1582	};
1334		1583
1335	$self->add_item ($item);	1584	$self->add_item ($item);
1336	}	1585	}
		1586
		1587	=item $popup->show
		1588
		1589	Displays the popup (which is initially hidden).
		1590
		1591	=cut
1337		1592
1338	sub show {	1593	sub show {
1339	my ($self) = @_;	1594	my ($self) = @_;
1340		1595
1341	local $urxvt::popup::self = $self;	1596	local $urxvt::popup::self = $self;
1342		1597
		1598	my $env = $self->{term}->env;
		1599	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1600	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1601	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1602
		1603	urxvt::term->new ($env, "popup",
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1604	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1346	"--transient-for" => $self->{term}->parent,	1605	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1606	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1607	"-pe" => "urxvt-popup")
1349	or die "unable to create popup window\n";	1608	or die "unable to create popup window\n";
1350	}	1609	}
1351		1610
1352	sub DESTROY {	1611	sub DESTROY {
1353	my ($self) = @_;	1612	my ($self) = @_;
1354		1613
1355	delete $self->{term}{_destroy}{$self};	1614	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1615	$self->{term}->ungrab;
1357	}	1616	}
		1617
		1618	=back
1358		1619
1359	=head2 The C<urxvt::timer> Class	1620	=head2 The C<urxvt::timer> Class
1360		1621
1361	This class implements timer watchers/events. Time is represented as a	1622	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1623	fractional number of seconds since the epoch. Example:
…		…
1400	Start the timer.	1661	Start the timer.
1401		1662
1402	=item $timer = $timer->start ($tstamp)	1663	=item $timer = $timer->start ($tstamp)
1403		1664
1404	Set the event trigger time to C<$tstamp> and start the timer.	1665	Set the event trigger time to C<$tstamp> and start the timer.
		1666
		1667	=item $timer = $timer->after ($delay)
		1668
		1669	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1405		1670
1406	=item $timer = $timer->stop	1671	=item $timer = $timer->stop
1407		1672
1408	Stop the timer.	1673	Stop the timer.
1409		1674
…		…
1469		1734
1470	=item == 0 - fatal messages	1735	=item == 0 - fatal messages
1471		1736
1472	=item >= 3 - script loading and management	1737	=item >= 3 - script loading and management
1473		1738
1474	=item >=10 - all events received	1739	=item >=10 - all called hooks
		1740
		1741	=item >=11 - hook reutrn values
1475		1742
1476	=back	1743	=back
1477		1744
1478	=head1 AUTHOR	1745	=head1 AUTHOR
1479		1746

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs. Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC