[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.102 by root, Wed Jan 18 10:31:37 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.
89		168
90	=item block-graphics-to-ascii	169	=item block-graphics-to-ascii
91		170
92	A not very useful example of filtering all text output to the terminal,	171	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	172	by replacing all line-drawing characters (U+2500 .. U+259F) by a
94	similar-looking ascii character.	173	similar-looking ascii character.
95		174
		175	=item digital-clock
		176
		177	Displays a digital clock using the built-in overlay.
		178
96	=item example-refresh-hooks	179	=item example-refresh-hooks
97		180
98	Displays a very simple digital clock in the upper right corner of the	181	Displays a very simple digital clock in the upper right corner of the
99	window. Illustrates overwriting the refresh callbacks to create your own	182	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	183	overlays or changes.
101		184
		185	=item selection-pastebin
		186
		187	This is a little rarely useful extension that Uploads the selection as
		188	textfile to a remote site (or does other things). (The implementation is
		189	not currently secure for use in a multiuser environment as it writes to
		190	F</tmp> directly.).
		191
		192	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		193	i.e.
		194
		195	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		196
		197	Pressing this combination runs a command with C<%> replaced by the name of
		198	the textfile. This command can be set via a resource:
		199
		200	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		201
		202	And the default is likely not useful to anybody but the few people around
		203	here :)
		204
		205	The name of the textfile is the hex encoded md5 sum of the selection, so
		206	the same content should lead to the same filename.
		207
		208	After a successful upload the selection will be replaced by the text given
		209	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		210	for the filename):
		211
		212	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		213
102	=back	214	=back
		215
		216	=head1 API DOCUMENTATION
103		217
104	=head2 General API Considerations	218	=head2 General API Considerations
105		219
106	All objects (such as terminals, time watchers etc.) are typical	220	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	221	reference-to-hash objects. The hash can be used to store anything you
…		…
120	=over 4	234	=over 4
121		235
122	=item $text	236	=item $text
123		237
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	238	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.	239	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		240
127	=item $string	241	=item $string
128		242
129	A perl text string, with an emphasis on I<text>. It can store all unicode	243	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	244	characters and is to be distinguished with text encoded in a specific
…		…
225	=item on_sel_extend $term	339	=item on_sel_extend $term
226		340
227	Called whenever the user tries to extend the selection (e.g. with a double	341	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	342	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	343	should extend the selection itelf and return true to suppress the built-in
230	processing.	344	processing. This can happen multiple times, as long as the callback
		345	returns true, it will be called on every further click by the user and is
		346	supposed to enlarge the selection more and more, if possible.
231		347
232	See the F<selection> example extension.	348	See the F<selection> example extension.
233		349
234	=item on_view_change $term, $offset	350	=item on_view_change $term, $offset
235		351
…		…
302		418
303	Called whenever the user presses a key combination that has a	419	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>	420	C<perl:string> action bound to it (see description of the B<keysym>
305	resource in the @@RXVT_NAME@@(1) manpage).	421	resource in the @@RXVT_NAME@@(1) manpage).
306		422
		423	=item on_x_event $term, $event
		424
		425	Called on every X event received on the vt window (and possibly other
		426	windows). Should only be used as a last resort. Most event structure
		427	members are not passed.
		428
307	=item on_focus_in $term	429	=item on_focus_in $term
308		430
309	Called whenever the window gets the keyboard focus, before rxvt-unicode	431	Called whenever the window gets the keyboard focus, before rxvt-unicode
310	does focus in processing.	432	does focus in processing.
311		433
312	=item on_focus_out $term	434	=item on_focus_out $term
313		435
314	Called wheneever the window loses keyboard focus, before rxvt-unicode does	436	Called wheneever the window loses keyboard focus, before rxvt-unicode does
315	focus out processing.	437	focus out processing.
		438
		439	=item on_configure_notify $term, $event
316		440
317	=item on_key_press $term, $event, $keysym, $octets	441	=item on_key_press $term, $event, $keysym, $octets
318		442
319	=item on_key_release $term, $event, $keysym	443	=item on_key_release $term, $event, $keysym
320		444
…		…
337		461
338	C<on_key_press> additionally receives the string rxvt-unicode would	462	C<on_key_press> additionally receives the string rxvt-unicode would
339	output, if any, in locale-specific encoding.	463	output, if any, in locale-specific encoding.
340		464
341	subwindow.	465	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		466
453	=back	467	=back
454		468
455	=cut	469	=cut
456		470
…		…
471	our $LIBDIR;	485	our $LIBDIR;
472	our $RESNAME;	486	our $RESNAME;
473	our $RESCLASS;	487	our $RESCLASS;
474	our $RXVTNAME;	488	our $RXVTNAME;
475		489
		490	=head2 Variables in the C<urxvt> Package
		491
		492	=over 4
		493
		494	=item $urxvt::LIBDIR
		495
		496	The rxvt-unicode library directory, where, among other things, the perl
		497	modules and scripts are stored.
		498
		499	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		500
		501	The resource class and name rxvt-unicode uses to look up X resources.
		502
		503	=item $urxvt::RXVTNAME
		504
		505	The basename of the installed binaries, usually C<urxvt>.
		506
		507	=item $urxvt::TERM
		508
		509	The current terminal. This variable stores the current C<urxvt::term>
		510	object, whenever a callback/hook is executing.
		511
		512	=back
		513
		514	=head2 Functions in the C<urxvt> Package
		515
		516	=over 4
		517
		518	=item urxvt::fatal $errormessage
		519
		520	Fatally aborts execution with the given error message. Avoid at all
		521	costs! The only time this is acceptable is when the terminal process
		522	starts up.
		523
		524	=item urxvt::warn $string
		525
		526	Calls C<rxvt_warn> with the given string which should not include a
		527	newline. The module also overwrites the C<warn> builtin with a function
		528	that calls this function.
		529
		530	Using this function has the advantage that its output ends up in the
		531	correct place, e.g. on stderr of the connecting urxvtc client.
		532
		533	Messages have a size limit of 1023 bytes currently.
		534
		535	=item $time = urxvt::NOW
		536
		537	Returns the "current time" (as per the event loop).
		538
		539	=item urxvt::CurrentTime
		540
		541	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		542	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		543	Button4Mask, Button5Mask, AnyModifier
		544
		545	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		546	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		547	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		548	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		549	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		550	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		551	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		552
		553	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		554	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		555	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		556	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		557	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		558	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		559	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		560
		561	Various constants for use in X calls and event processing.
		562
		563	=back
		564
		565	=head2 RENDITION
		566
		567	Rendition bitsets contain information about colour, font, font styles and
		568	similar information for each screen cell.
		569
		570	The following "macros" deal with changes in rendition sets. You should
		571	never just create a bitset, you should always modify an existing one,
		572	as they contain important information required for correct operation of
		573	rxvt-unicode.
		574
		575	=over 4
		576
		577	=item $rend = urxvt::DEFAULT_RSTYLE
		578
		579	Returns the default rendition, as used when the terminal is starting up or
		580	being reset. Useful as a base to start when creating renditions.
		581
		582	=item $rend = urxvt::OVERLAY_RSTYLE
		583
		584	Return the rendition mask used for overlays by default.
		585
		586	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		587
		588	Return the bit that enabled bold, italic, blink, reverse-video and
		589	underline, respectively. To enable such a style, just logically OR it into
		590	the bitset.
		591
		592	=item $foreground = urxvt::GET_BASEFG $rend
		593
		594	=item $background = urxvt::GET_BASEBG $rend
		595
		596	Return the foreground/background colour index, respectively.
		597
		598	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		599
		600	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		601
		602	Replace the foreground/background colour in the rendition mask with the
		603	specified one.
		604
		605	=item $value = urxvt::GET_CUSTOM $rend
		606
		607	Return the "custom" value: Every rendition has 5 bits for use by
		608	extensions. They can be set and changed as you like and are initially
		609	zero.
		610
		611	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		612
		613	Change the custom value.
		614
		615	=back
		616
		617	=cut
		618
476	BEGIN {	619	BEGIN {
477	urxvt->bootstrap;
478
479	# overwrite perl's warn	620	# overwrite perl's warn
480	*CORE::GLOBAL::warn = sub {	621	*CORE::GLOBAL::warn = sub {
481	my $msg = join "", @_;	622	my $msg = join "", @_;
482	$msg .= "\n"	623	$msg .= "\n"
483	unless $msg =~ /\n$/;	624	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	625	urxvt::warn ($msg);
485	};	626	};
486		627
		628	# %ENV is the original startup environment
487	delete $ENV{IFS};	629	delete $ENV{IFS};
488	delete $ENV{CDPATH};	630	delete $ENV{CDPATH};
489	delete $ENV{BASH_ENV};	631	delete $ENV{BASH_ENV};
490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	632	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
491	}	633	}
492		634
493	my @hook_count;
494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	635	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495		636
496	sub verbose {	637	sub verbose {
497	my ($level, $msg) = @_;	638	my ($level, $msg) = @_;
498	warn "$msg\n" if $level <= $verbosity;	639	warn "$msg\n" if $level <= $verbosity;
499	}	640	}
500		641
501	my $extension_pkg = "extension0000";
502	my %extension_pkg;	642	my %extension_pkg;
503		643
504	# load a single script into its own package, once only	644	# load a single script into its own package, once only
505	sub extension_package($) {	645	sub extension_package($) {
506	my ($path) = @_;	646	my ($path) = @_;
507		647
		648	no strict 'refs';
		649
508	$extension_pkg{$path} \|\|= do {	650	$extension_pkg{$path} \|\|= do {
509	my $pkg = "urxvt::" . ($extension_pkg++);	651	$path =~ /([^\/\\]+)$/;
		652	my $pkg = $1;
		653	$pkg =~ s/[^[:word:]]/_/g;
		654	$pkg = "urxvt::ext::$pkg";
510		655
511	verbose 3, "loading extension '$path' into package '$pkg'";	656	verbose 3, "loading extension '$path' into package '$pkg'";
512		657
513	open my $fh, "<:raw", $path	658	open my $fh, "<:raw", $path
514	or die "$path: $!";	659	or die "$path: $!";
515		660
		661	@{"$pkg\::ISA"} = urxvt::term::extension::;
		662
516	my $source = untaint	663	my $source =
517	"package $pkg; use strict; use utf8;\n"	664	"package $pkg; use strict; use utf8;\n"
518	. "use base urxvt::term::extension::;\n"
519	. "#line 1 \"$path\"\n{\n"	665	. "#line 1 \"$path\"\n{\n"
520	. (do { local $/; <$fh> })	666	. (do { local $/; <$fh> })
521	. "\n};\n1";	667	. "\n};\n1";
522		668
523	eval $source	669	eval $source
…		…
580	if ($@) {	726	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	727	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	728	warn $@;
583	}	729	}
584	}	730	}
		731
		732	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		733	if $verbosity >= 11;
585	}	734	}
586		735
587	if ($htype == 1) { # DESTROY	736	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	737	# clear package objects
596	%$_ = () for values %{ $TERM->{_pkg} };	738	%$_ = () for values %{ $TERM->{_pkg} };
597		739
598	# clear package	740	# clear package
599	%$TERM = ();	741	%$TERM = ();
600	}	742	}
601		743
602	$retval	744	$retval
		745	}
		746
		747	sub exec_async(@) {
		748	my $pid = fork;
		749
		750	return
		751	if !defined $pid or $pid;
		752
		753	%ENV = %{ $TERM->env };
		754
		755	exec @_;
		756	_exit 255;
603	}	757	}
604		758
605	# urxvt::term::extension	759	# urxvt::term::extension
606		760
607	package urxvt::term::extension;	761	package urxvt::term::extension;
…		…
613	while (my ($name, $cb) = each %hook) {	767	while (my ($name, $cb) = each %hook) {
614	my $htype = $HOOKTYPE{uc $name};	768	my $htype = $HOOKTYPE{uc $name};
615	defined $htype	769	defined $htype
616	or Carp::croak "unsupported hook type '$name'";	770	or Carp::croak "unsupported hook type '$name'";
617		771
		772	$self->set_should_invoke ($htype, +1)
618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	773	unless exists $self->{term}{_hook}[$htype]{$pkg};
619	$hook_count[$htype]++
620	or urxvt::set_should_invoke $htype, 1;
621	}
622		774
623	$self->{term}{_hook}[$htype]{$pkg} = $cb;	775	$self->{term}{_hook}[$htype]{$pkg} = $cb;
624	}	776	}
625	}	777	}
626		778
…		…
631	for my $name (@hook) {	783	for my $name (@hook) {
632	my $htype = $HOOKTYPE{uc $name};	784	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	785	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	786	or Carp::croak "unsupported hook type '$name'";
635		787
		788	$self->set_should_invoke ($htype, -1)
636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	789	if delete $self->{term}{_hook}[$htype]{$pkg};
637	--$hook_count[$htype]
638	or urxvt::set_should_invoke $htype, 0;
639	}
640	}	790	}
641	}	791	}
642		792
643	our $AUTOLOAD;	793	our $AUTOLOAD;
644		794
…		…
675		825
676	=head2 The C<urxvt::anyevent> Class	826	=head2 The C<urxvt::anyevent> Class
677		827
678	The sole purpose of this class is to deliver an interface to the	828	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	829	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	830	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	831	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	832	is that you cannot use blocking APIs, but the non-blocking variant should
		833	work.
683		834
684	=cut	835	=cut
685		836
686	our $VERSION = 1;	837	our $VERSION = 1;
687		838
…		…
764	$proxy->enable ($name => $ref);	915	$proxy->enable ($name => $ref);
765	}	916	}
766	}	917	}
767	}	918	}
768		919
		920	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		921
		922	Creates a new terminal, very similar as if you had started it with system
		923	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		924	hash which defines the environment of the new terminal.
		925
		926	Croaks (and probably outputs an error message) if the new instance
		927	couldn't be created. Returns C<undef> if the new instance didn't
		928	initialise perl, and the terminal object otherwise. The C<init> and
		929	C<start> hooks will be called during this call.
		930
		931	=cut
		932
		933	sub new {
		934	my ($class, $env, @args) = @_;
		935
		936	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		937	}
		938
769	=item $term->destroy	939	=item $term->destroy
770		940
771	Destroy the terminal object (close the window, free resources etc.).	941	Destroy the terminal object (close the window, free resources
		942	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		943	watchers (timers, io watchers) are still active.
772		944
773	=item $isset = $term->option ($optval[, $set])	945	=item $isset = $term->option ($optval[, $set])
774		946
775	Returns true if the option specified by C<$optval> is enabled, and	947	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	948	optionally change it. All option values are stored by name in the hash
…		…
826	my ($self, $name) = (shift, shift);	998	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	999	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	1000	&urxvt::term::_resource
829	}	1001	}
830		1002
		1003	=item $value = $term->x_resource ($pattern)
		1004
		1005	Returns the X-Resource for the given pattern, excluding the program or
		1006	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1007	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1008	resource with that pattern exists.
		1009
		1010	This method should only be called during the C<on_start> hook, as there is
		1011	only one resource database per display, and later invocations might return
		1012	the wrong resources.
		1013
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1014	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		1015
833	Adds a keymap translation exactly as specified via a resource. See the	1016	Adds a keymap translation exactly as specified via a resource. See the
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1017	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835		1018
…		…
850	=item ($row, $col) = $term->selection_end ([$row, $col])	1033	=item ($row, $col) = $term->selection_end ([$row, $col])
851		1034
852	Return the current values of the selection mark, begin or end positions,	1035	Return the current values of the selection mark, begin or end positions,
853	and optionally set them to new values.	1036	and optionally set them to new values.
854		1037
		1038	=item $term->selection_make ($eventtime[, $rectangular])
		1039
		1040	Tries to make a selection as set by C<selection_beg> and
		1041	C<selection_end>. If C<$rectangular> is true (default: false), a
		1042	rectangular selection will be made. This is the prefered function to make
		1043	a selection.
		1044
855	=item $success = $term->selection_grab ($eventtime)	1045	=item $success = $term->selection_grab ($eventtime)
856		1046
857	Try to request the primary selection from the server (for example, as set	1047	Try to request the primary selection text from the server (for example, as
858	by the next method).	1048	set by the next method). No visual feedback will be given. This function
		1049	is mostly useful from within C<on_sel_grab> hooks.
859		1050
860	=item $oldtext = $term->selection ([$newtext])	1051	=item $oldtext = $term->selection ([$newtext])
861		1052
862	Return the current selection text and optionally replace it by C<$newtext>.	1053	Return the current selection text and optionally replace it by C<$newtext>.
863		1054
…		…
956	Convert the given locale-encoded octets into a perl string.	1147	Convert the given locale-encoded octets into a perl string.
957		1148
958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1149	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959		1150
960	XORs the rendition values in the given span with the provided value	1151	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	1152	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962	to the selection.	1153	refresh hooks to provide effects similar to the selection.
963		1154
964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1155	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965		1156
966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1157	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1158	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	1159	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
969	it instead.	1160	it instead. Both styles I<MUST NOT> contain font styles.
970		1161
971	=item $term->scr_bell	1162	=item $term->scr_bell
972		1163
973	Ring the bell!	1164	Ring the bell!
974		1165
…		…
1008		1199
1009	=item $windowid = $term->vt	1200	=item $windowid = $term->vt
1010		1201
1011	Return the window id of the terminal window.	1202	Return the window id of the terminal window.
1012		1203
		1204	=item $term->vt_emask_add ($x_event_mask)
		1205
		1206	Adds the specified events to the vt event mask. Useful e.g. when you want
		1207	to receive pointer events all the times:
		1208
		1209	$term->vt_emask_add (urxvt::PointerMotionMask);
		1210
1013	=item $window_width = $term->width	1211	=item $window_width = $term->width
1014		1212
1015	=item $window_height = $term->height	1213	=item $window_height = $term->height
1016		1214
1017	=item $font_width = $term->fwidth	1215	=item $font_width = $term->fwidth
…		…
1030		1228
1031	=item $max_scrollback = $term->saveLines	1229	=item $max_scrollback = $term->saveLines
1032		1230
1033	=item $nrow_plus_saveLines = $term->total_rows	1231	=item $nrow_plus_saveLines = $term->total_rows
1034		1232
1035	=item $lines_in_scrollback = $term->nsaved	1233	=item $topmost_scrollback_row = $term->top_row
1036		1234
1037	Return various integers describing terminal characteristics.	1235	Return various integers describing terminal characteristics.
1038		1236
		1237	=item $x_display = $term->display_id
		1238
		1239	Return the DISPLAY used by rxvt-unicode.
		1240
1039	=item $lc_ctype = $term->locale	1241	=item $lc_ctype = $term->locale
1040		1242
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1243	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1244
1043	=item $x_display = $term->display_id	1245	=item $env = $term->env
1044		1246
1045	Return the DISPLAY used by rxvt-unicode.	1247	Returns a copy of the environment in effect for the terminal as a hashref
		1248	similar to C<\%ENV>.
		1249
		1250	=cut
		1251
		1252	sub env {
		1253	if (my $env = $_[0]->_env) {
		1254	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1255	} else {
		1256	+{ %ENV }
		1257	}
		1258	}
1046		1259
1047	=item $modifiermask = $term->ModLevel3Mask	1260	=item $modifiermask = $term->ModLevel3Mask
1048		1261
1049	=item $modifiermask = $term->ModMetaMask	1262	=item $modifiermask = $term->ModMetaMask
1050		1263
…		…
1053	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1266	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.	1267	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1055		1268
1056	=item $view_start = $term->view_start ([$newvalue])	1269	=item $view_start = $term->view_start ([$newvalue])
1057		1270
1058	Returns the negative row number of the topmost line. Minimum value is	1271	Returns the row number of the topmost displayed line. Maximum value is
1059	C<0>, which displays the normal terminal contents. Larger values scroll	1272	C<0>, which displays the normal terminal contents. Lower values scroll
1060	this many lines into the scrollback buffer.	1273	this many lines into the scrollback buffer.
1061		1274
1062	=item $term->want_refresh	1275	=item $term->want_refresh
1063		1276
1064	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1277	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.	1356	Return the row number of the first/last row of the line, respectively.
1144		1357
1145	=item $offset = $line->offset_of ($row, $col)	1358	=item $offset = $line->offset_of ($row, $col)
1146		1359
1147	Returns the character offset of the given row\|col pair within the logical	1360	Returns the character offset of the given row\|col pair within the logical
1148	line.	1361	line. Works for rows outside the line, too, and returns corresponding
		1362	offsets outside the string.
1149		1363
1150	=item ($row, $col) = $line->coord_of ($offset)	1364	=item ($row, $col) = $line->coord_of ($offset)
1151		1365
1152	Translates a string offset into terminal coordinates again.	1366	Translates a string offset into terminal coordinates again.
1153		1367
…		…
1290	$item->{render} \|\|= sub { $_[0]{text} };	1504	$item->{render} \|\|= sub { $_[0]{text} };
1291		1505
1292	push @{ $self->{item} }, $item;	1506	push @{ $self->{item} }, $item;
1293	}	1507	}
1294		1508
		1509	=item $popup->add_title ($title)
		1510
		1511	Adds a non-clickable title to the popup.
		1512
		1513	=cut
		1514
		1515	sub add_title {
		1516	my ($self, $title) = @_;
		1517
		1518	$self->add_item ({
		1519	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1520	text => $title,
		1521	activate => sub { },
		1522	});
		1523	}
		1524
		1525	=item $popup->add_separator ([$sepchr])
		1526
		1527	Creates a separator, optionally using the character given as C<$sepchr>.
		1528
		1529	=cut
		1530
1295	sub add_separator {	1531	sub add_separator {
1296	my ($self, $sep) = @_;	1532	my ($self, $sep) = @_;
1297		1533
1298	$sep \|\|= "=";	1534	$sep \|\|= "=";
1299		1535
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1539	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1540	activate => sub { },
1305	});	1541	});
1306	}	1542	}
1307		1543
1308	sub add_title {	1544	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1545
1311	$self->add_item ({	1546	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" },	1547	selected.
1313	text => $title,	1548
1314	activate => sub { },	1549	=cut
1315	});
1316	}
1317		1550
1318	sub add_button {	1551	sub add_button {
1319	my ($self, $text, $cb) = @_;	1552	my ($self, $text, $cb) = @_;
1320		1553
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1554	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	1555	}
		1556
		1557	=item $popup->add_toggle ($text, $cb, $initial_value)
		1558
		1559	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1560	whenever it gets toggled, with a boolean indicating its value as its first
		1561	argument.
		1562
		1563	=cut
1323		1564
1324	sub add_toggle {	1565	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1566	my ($self, $text, $cb, $value) = @_;
1326		1567
1327	my $item; $item = {	1568	my $item; $item = {
1328	type => "button",	1569	type => "button",
1329	text => " $text",	1570	text => " $text",
1330	value => $value,	1571	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1572	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1573	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1574	};
1334		1575
1335	$self->add_item ($item);	1576	$self->add_item ($item);
1336	}	1577	}
		1578
		1579	=item $popup->show
		1580
		1581	Displays the popup (which is initially hidden).
		1582
		1583	=cut
1337		1584
1338	sub show {	1585	sub show {
1339	my ($self) = @_;	1586	my ($self) = @_;
1340		1587
1341	local $urxvt::popup::self = $self;	1588	local $urxvt::popup::self = $self;
1342		1589
		1590	my $env = $self->{term}->env;
		1591	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1592	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1593	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1594
		1595	urxvt::term->new ($env, $self->{term}->resource ("name"),
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1596	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1346	"--transient-for" => $self->{term}->parent,	1597	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1598	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1599	"-pe" => "urxvt-popup")
1349	or die "unable to create popup window\n";	1600	or die "unable to create popup window\n";
1350	}	1601	}
1351		1602
1352	sub DESTROY {	1603	sub DESTROY {
1353	my ($self) = @_;	1604	my ($self) = @_;
1354		1605
1355	delete $self->{term}{_destroy}{$self};	1606	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1607	$self->{term}->ungrab;
1357	}	1608	}
		1609
		1610	=back
1358		1611
1359	=head2 The C<urxvt::timer> Class	1612	=head2 The C<urxvt::timer> Class
1360		1613
1361	This class implements timer watchers/events. Time is represented as a	1614	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1615	fractional number of seconds since the epoch. Example:
…		…
1469		1722
1470	=item == 0 - fatal messages	1723	=item == 0 - fatal messages
1471		1724
1472	=item >= 3 - script loading and management	1725	=item >= 3 - script loading and management
1473		1726
1474	=item >=10 - all events received	1727	=item >=10 - all called hooks
		1728
		1729	=item >=11 - hook reutrn values
1475		1730
1476	=back	1731	=back
1477		1732
1478	=head1 AUTHOR	1733	=head1 AUTHOR
1479		1734

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.102 by root, Wed Jan 18 10:31:37 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.102 by root, Wed Jan 18 10:31:37 2006 UTC