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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.71 by root, Mon Jan 9 23:18:49 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.
70		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	};
		111
71	=item searchable-scrollback (enabled by default)	112	=item searchable-scrollback<hotkey> (enabled by default)
72		113
73	Adds regex search functionality to the scrollback buffer, triggered by a	114	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	115	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,	116	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	117	screen.
77	current position and C<escape> returns to the original position.
78		118
79	=item digital-clock	119	Inputting characters appends them to the regex and continues incremental
		120	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		121	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		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.
80		126
81	Displays a digital clock using the built-in overlay.	127	=item selection-autotransform
		128
		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.
82		161
83	=item mark-urls	162	=item mark-urls
84		163
85	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
86		176
87	=item block-graphics-to-ascii	177	=item block-graphics-to-ascii
88		178
89	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,
90	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
91	similar-looking ascii character.	181	similar-looking ascii character.
92		182
		183	=item digital-clock
		184
		185	Displays a digital clock using the built-in overlay.
		186
93	=item example-refresh-hooks	187	=item example-refresh-hooks
94		188
95	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
96	window. Illustrates overwriting the refresh callbacks to create your own	190	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	191	overlays or changes.
98		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
99	=back	222	=back
		223
		224	=head1 API DOCUMENTATION
100		225
101	=head2 General API Considerations	226	=head2 General API Considerations
102		227
103	All objects (such as terminals, time watchers etc.) are typical	228	All objects (such as terminals, time watchers etc.) are typical
104	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
…		…
117	=over 4	242	=over 4
118		243
119	=item $text	244	=item $text
120		245
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	246	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.	247	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		248
124	=item $string	249	=item $string
125		250
126	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
127	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
…		…
222	=item on_sel_extend $term	347	=item on_sel_extend $term
223		348
224	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
225	click) and is either supposed to return false (normal operation), or	350	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	351	should extend the selection itelf and return true to suppress the built-in
227	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.
228		355
229	See the F<selection> example extension.	356	See the F<selection> example extension.
230		357
231	=item on_view_change $term, $offset	358	=item on_view_change $term, $offset
232		359
…		…
263	can filter/change and output the text yourself by returning a true value	390	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	391	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	392	might be very slow, however, as your hook is called for B<all> text being
266	output.	393	output.
267		394
		395	=item on_tt_write $term, $octets
		396
		397	Called whenever some data is written to the tty/pty and can be used to
		398	suppress or filter tty input.
		399
268	=item on_line_update $term, $row	400	=item on_line_update $term, $row
269		401
270	Called whenever a line was updated or changed. Can be used to filter	402	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	403	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,	404	that are being shown will be filtered, and, due to performance reasons,
…		…
294		426
295	Called whenever the user presses a key combination that has a	427	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>	428	C<perl:string> action bound to it (see description of the B<keysym>
297	resource in the @@RXVT_NAME@@(1) manpage).	429	resource in the @@RXVT_NAME@@(1) manpage).
298		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
299	=item on_focus_in $term	437	=item on_focus_in $term
300		438
301	Called whenever the window gets the keyboard focus, before rxvt-unicode	439	Called whenever the window gets the keyboard focus, before rxvt-unicode
302	does focus in processing.	440	does focus in processing.
303		441
304	=item on_focus_out $term	442	=item on_focus_out $term
305		443
306	Called wheneever the window loses keyboard focus, before rxvt-unicode does	444	Called wheneever the window loses keyboard focus, before rxvt-unicode does
307	focus out processing.	445	focus out processing.
		446
		447	=item on_configure_notify $term, $event
308		448
309	=item on_key_press $term, $event, $keysym, $octets	449	=item on_key_press $term, $event, $keysym, $octets
310		450
311	=item on_key_release $term, $event, $keysym	451	=item on_key_release $term, $event, $keysym
312		452
…		…
329		469
330	C<on_key_press> additionally receives the string rxvt-unicode would	470	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	471	output, if any, in locale-specific encoding.
332		472
333	subwindow.	473	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		474
445	=back	475	=back
446		476
447	=cut	477	=cut
448		478
…		…
457	our $VERSION = 1;	487	our $VERSION = 1;
458	our $TERM;	488	our $TERM;
459	our @HOOKNAME;	489	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	491	our %OPTION;
		492
462	our $LIBDIR;	493	our $LIBDIR;
		494	our $RESNAME;
		495	our $RESCLASS;
		496	our $RXVTNAME;
		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
463		626
464	BEGIN {	627	BEGIN {
465	urxvt->bootstrap;
466
467	# overwrite perl's warn	628	# overwrite perl's warn
468	*CORE::GLOBAL::warn = sub {	629	*CORE::GLOBAL::warn = sub {
469	my $msg = join "", @_;	630	my $msg = join "", @_;
470	$msg .= "\n"	631	$msg .= "\n"
471	unless $msg =~ /\n$/;	632	unless $msg =~ /\n$/;
472	urxvt::warn ($msg);	633	urxvt::warn ($msg);
473	};	634	};
474		635
		636	# %ENV is the original startup environment
475	delete $ENV{IFS};	637	delete $ENV{IFS};
476	delete $ENV{CDPATH};	638	delete $ENV{CDPATH};
477	delete $ENV{BASH_ENV};	639	delete $ENV{BASH_ENV};
478	$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";
479	}	641	}
480		642
481	my @hook_count;
482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	643	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
483		644
484	sub verbose {	645	sub verbose {
485	my ($level, $msg) = @_;	646	my ($level, $msg) = @_;
486	warn "$msg\n" if $level <= $verbosity;	647	warn "$msg\n" if $level <= $verbosity;
487	}	648	}
488		649
489	my $extension_pkg = "extension0000";
490	my %extension_pkg;	650	my %extension_pkg;
491		651
492	# load a single script into its own package, once only	652	# load a single script into its own package, once only
493	sub extension_package($) {	653	sub extension_package($) {
494	my ($path) = @_;	654	my ($path) = @_;
495		655
		656	no strict 'refs';
		657
496	$extension_pkg{$path} \|\|= do {	658	$extension_pkg{$path} \|\|= do {
497	my $pkg = "urxvt::" . ($extension_pkg++);	659	$path =~ /([^\/\\]+)$/;
		660	my $pkg = $1;
		661	$pkg =~ s/[^[:word:]]/_/g;
		662	$pkg = "urxvt::ext::$pkg";
498		663
499	verbose 3, "loading extension '$path' into package '$pkg'";	664	verbose 3, "loading extension '$path' into package '$pkg'";
500		665
501	open my $fh, "<:raw", $path	666	open my $fh, "<:raw", $path
502	or die "$path: $!";	667	or die "$path: $!";
503		668
		669	@{"$pkg\::ISA"} = urxvt::term::extension::;
		670
504	my $source = untaint	671	my $source =
505	"package $pkg; use strict; use utf8;\n"	672	"package $pkg; use strict; use utf8;\n"
506	. "use base urxvt::term::extension::;\n"
507	. "#line 1 \"$path\"\n{\n"	673	. "#line 1 \"$path\"\n{\n"
508	. (do { local $/; <$fh> })	674	. (do { local $/; <$fh> })
509	. "\n};\n1";	675	. "\n};\n1";
510		676
511	eval $source	677	eval $source
…		…
568	if ($@) {	734	if ($@) {
569	$TERM->ungrab; # better to lose the grab than the session	735	$TERM->ungrab; # better to lose the grab than the session
570	warn $@;	736	warn $@;
571	}	737	}
572	}	738	}
		739
		740	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		741	if $verbosity >= 11;
573	}	742	}
574		743
575	if ($htype == 1) { # DESTROY	744	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	745	# clear package objects
584	%$_ = () for values %{ $TERM->{_pkg} };	746	%$_ = () for values %{ $TERM->{_pkg} };
585		747
586	# clear package	748	# clear package
587	%$TERM = ();	749	%$TERM = ();
588	}	750	}
589		751
590	$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;
591	}	765	}
592		766
593	# urxvt::term::extension	767	# urxvt::term::extension
594		768
595	package urxvt::term::extension;	769	package urxvt::term::extension;
…		…
601	while (my ($name, $cb) = each %hook) {	775	while (my ($name, $cb) = each %hook) {
602	my $htype = $HOOKTYPE{uc $name};	776	my $htype = $HOOKTYPE{uc $name};
603	defined $htype	777	defined $htype
604	or Carp::croak "unsupported hook type '$name'";	778	or Carp::croak "unsupported hook type '$name'";
605		779
		780	$self->set_should_invoke ($htype, +1)
606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	781	unless exists $self->{term}{_hook}[$htype]{$pkg};
607	$hook_count[$htype]++
608	or urxvt::set_should_invoke $htype, 1;
609	}
610		782
611	$self->{term}{_hook}[$htype]{$pkg} = $cb;	783	$self->{term}{_hook}[$htype]{$pkg} = $cb;
612	}	784	}
613	}	785	}
614		786
…		…
619	for my $name (@hook) {	791	for my $name (@hook) {
620	my $htype = $HOOKTYPE{uc $name};	792	my $htype = $HOOKTYPE{uc $name};
621	defined $htype	793	defined $htype
622	or Carp::croak "unsupported hook type '$name'";	794	or Carp::croak "unsupported hook type '$name'";
623		795
		796	$self->set_should_invoke ($htype, -1)
624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	797	if delete $self->{term}{_hook}[$htype]{$pkg};
625	--$hook_count[$htype]
626	or urxvt::set_should_invoke $htype, 0;
627	}
628	}	798	}
629	}	799	}
630		800
631	our $AUTOLOAD;	801	our $AUTOLOAD;
632		802
…		…
663		833
664	=head2 The C<urxvt::anyevent> Class	834	=head2 The C<urxvt::anyevent> Class
665		835
666	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
667	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
668	further work. The only exception is that you cannot wait on condition	838	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	839	condition variables, but non-blocking condvar use is ok. What this means
670	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.
671		842
672	=cut	843	=cut
673		844
674	our $VERSION = 1;	845	our $VERSION = 1;
675		846
…		…
752	$proxy->enable ($name => $ref);	923	$proxy->enable ($name => $ref);
753	}	924	}
754	}	925	}
755	}	926	}
756		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
757	=item $term->destroy	947	=item $term->destroy
758		948
759	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.
760		952
761	=item $isset = $term->option ($optval[, $set])	953	=item $isset = $term->option ($optval[, $set])
762		954
763	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
764	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
…		…
814	my ($self, $name) = (shift, shift);	1006	my ($self, $name) = (shift, shift);
815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1007	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
816	&urxvt::term::_resource	1008	&urxvt::term::_resource
817	}	1009	}
818		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
819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1022	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820		1023
821	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
822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1025	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823		1026
…		…
838	=item ($row, $col) = $term->selection_end ([$row, $col])	1041	=item ($row, $col) = $term->selection_end ([$row, $col])
839		1042
840	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,
841	and optionally set them to new values.	1044	and optionally set them to new values.
842		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
843	=item $success = $term->selection_grab ($eventtime)	1053	=item $success = $term->selection_grab ($eventtime)
844		1054
845	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
846	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.
847		1058
848	=item $oldtext = $term->selection ([$newtext])	1059	=item $oldtext = $term->selection ([$newtext])
849		1060
850	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>.
851		1062
…		…
944	Convert the given locale-encoded octets into a perl string.	1155	Convert the given locale-encoded octets into a perl string.
945		1156
946	=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])
947		1158
948	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
949	(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
950	to the selection.	1161	refresh hooks to provide effects similar to the selection.
951		1162
952	=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]])
953		1164
954	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
955	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1166	whitespace will additionally be xored with the C<$rstyle2>, which defaults
956	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1167	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
957	it instead.	1168	it instead. Both styles I<MUST NOT> contain font styles.
958		1169
959	=item $term->scr_bell	1170	=item $term->scr_bell
960		1171
961	Ring the bell!	1172	Ring the bell!
962		1173
…		…
996		1207
997	=item $windowid = $term->vt	1208	=item $windowid = $term->vt
998		1209
999	Return the window id of the terminal window.	1210	Return the window id of the terminal window.
1000		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
1001	=item $window_width = $term->width	1219	=item $window_width = $term->width
1002		1220
1003	=item $window_height = $term->height	1221	=item $window_height = $term->height
1004		1222
1005	=item $font_width = $term->fwidth	1223	=item $font_width = $term->fwidth
…		…
1018		1236
1019	=item $max_scrollback = $term->saveLines	1237	=item $max_scrollback = $term->saveLines
1020		1238
1021	=item $nrow_plus_saveLines = $term->total_rows	1239	=item $nrow_plus_saveLines = $term->total_rows
1022		1240
1023	=item $lines_in_scrollback = $term->nsaved	1241	=item $topmost_scrollback_row = $term->top_row
1024		1242
1025	Return various integers describing terminal characteristics.	1243	Return various integers describing terminal characteristics.
1026		1244
		1245	=item $x_display = $term->display_id
		1246
		1247	Return the DISPLAY used by rxvt-unicode.
		1248
1027	=item $lc_ctype = $term->locale	1249	=item $lc_ctype = $term->locale
1028		1250
1029	Returns the LC_CTYPE category string used by this rxvt-unicode.	1251	Returns the LC_CTYPE category string used by this rxvt-unicode.
1030		1252
1031	=item $x_display = $term->display_id	1253	=item $env = $term->env
1032		1254
1033	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	}
1034		1267
1035	=item $modifiermask = $term->ModLevel3Mask	1268	=item $modifiermask = $term->ModLevel3Mask
1036		1269
1037	=item $modifiermask = $term->ModMetaMask	1270	=item $modifiermask = $term->ModMetaMask
1038		1271
…		…
1041	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
1042	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.
1043		1276
1044	=item $view_start = $term->view_start ([$newvalue])	1277	=item $view_start = $term->view_start ([$newvalue])
1045		1278
1046	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
1047	C<0>, which displays the normal terminal contents. Larger values scroll	1280	C<0>, which displays the normal terminal contents. Lower values scroll
1048	this many lines into the scrollback buffer.	1281	this many lines into the scrollback buffer.
1049		1282
1050	=item $term->want_refresh	1283	=item $term->want_refresh
1051		1284
1052	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1285	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1131	Return the row number of the first/last row of the line, respectively.	1364	Return the row number of the first/last row of the line, respectively.
1132		1365
1133	=item $offset = $line->offset_of ($row, $col)	1366	=item $offset = $line->offset_of ($row, $col)
1134		1367
1135	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
1136	line.	1369	line. Works for rows outside the line, too, and returns corresponding
		1370	offsets outside the string.
1137		1371
1138	=item ($row, $col) = $line->coord_of ($offset)	1372	=item ($row, $col) = $line->coord_of ($offset)
1139		1373
1140	Translates a string offset into terminal coordinates again.	1374	Translates a string offset into terminal coordinates again.
1141		1375
…		…
1278	$item->{render} \|\|= sub { $_[0]{text} };	1512	$item->{render} \|\|= sub { $_[0]{text} };
1279		1513
1280	push @{ $self->{item} }, $item;	1514	push @{ $self->{item} }, $item;
1281	}	1515	}
1282		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
1283	sub add_separator {	1539	sub add_separator {
1284	my ($self, $sep) = @_;	1540	my ($self, $sep) = @_;
1285		1541
1286	$sep \|\|= "=";	1542	$sep \|\|= "=";
1287		1543
…		…
1291	render => sub { $sep x $self->{term}->ncol },	1547	render => sub { $sep x $self->{term}->ncol },
1292	activate => sub { },	1548	activate => sub { },
1293	});	1549	});
1294	}	1550	}
1295		1551
1296	sub add_title {	1552	=item $popup->add_button ($text, $cb)
1297	my ($self, $title) = @_;
1298		1553
1299	$self->add_item ({	1554	Adds a clickable button to the popup. C<$cb> is called whenever it is
1300	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1555	selected.
1301	text => $title,	1556
1302	activate => sub { },	1557	=cut
1303	});
1304	}
1305		1558
1306	sub add_button {	1559	sub add_button {
1307	my ($self, $text, $cb) = @_;	1560	my ($self, $text, $cb) = @_;
1308		1561
1309	$self->add_item ({ type => "button", text => $text, activate => $cb});	1562	$self->add_item ({ type => "button", text => $text, activate => $cb});
1310	}	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
1311		1572
1312	sub add_toggle {	1573	sub add_toggle {
1313	my ($self, $text, $cb, $value) = @_;	1574	my ($self, $text, $cb, $value) = @_;
1314		1575
1315	my $item; $item = {	1576	my $item; $item = {
1316	type => "button",	1577	type => "button",
1317	text => " $text",	1578	text => " $text",
1318	value => $value,	1579	value => $value,
1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1580	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1581	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1321	};	1582	};
1322		1583
1323	$self->add_item ($item);	1584	$self->add_item ($item);
1324	}	1585	}
		1586
		1587	=item $popup->show
		1588
		1589	Displays the popup (which is initially hidden).
		1590
		1591	=cut
1325		1592
1326	sub show {	1593	sub show {
1327	my ($self) = @_;	1594	my ($self) = @_;
1328		1595
1329	local $urxvt::popup::self = $self;	1596	local $urxvt::popup::self = $self;
1330		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};
1331	local $ENV{LC_ALL} = $self->{term}->locale;	1601	$env->{LC_CTYPE} = $self->{term}->locale;
1332		1602
		1603	urxvt::term->new ($env, "popup",
1333	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,
1334	"--transient-for" => $self->{term}->parent,	1605	"--transient-for" => $self->{term}->parent,
1335	"-display" => $self->{term}->display_id,	1606	"-display" => $self->{term}->display_id,
1336	"-pe" => "urxvt-popup")	1607	"-pe" => "urxvt-popup")
1337	or die "unable to create popup window\n";	1608	or die "unable to create popup window\n";
1338	}	1609	}
1339		1610
1340	sub DESTROY {	1611	sub DESTROY {
1341	my ($self) = @_;	1612	my ($self) = @_;
1342		1613
1343	delete $self->{term}{_destroy}{$self};	1614	delete $self->{term}{_destroy}{$self};
1344	$self->{term}->ungrab;	1615	$self->{term}->ungrab;
1345	}	1616	}
		1617
		1618	=back
1346		1619
1347	=head2 The C<urxvt::timer> Class	1620	=head2 The C<urxvt::timer> Class
1348		1621
1349	This class implements timer watchers/events. Time is represented as a	1622	This class implements timer watchers/events. Time is represented as a
1350	fractional number of seconds since the epoch. Example:	1623	fractional number of seconds since the epoch. Example:
…		…
1388	Start the timer.	1661	Start the timer.
1389		1662
1390	=item $timer = $timer->start ($tstamp)	1663	=item $timer = $timer->start ($tstamp)
1391		1664
1392	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>.
1393		1670
1394	=item $timer = $timer->stop	1671	=item $timer = $timer->stop
1395		1672
1396	Stop the timer.	1673	Stop the timer.
1397		1674
…		…
1457		1734
1458	=item == 0 - fatal messages	1735	=item == 0 - fatal messages
1459		1736
1460	=item >= 3 - script loading and management	1737	=item >= 3 - script loading and management
1461		1738
1462	=item >=10 - all events received	1739	=item >=10 - all called hooks
		1740
		1741	=item >=11 - hook reutrn values
1463		1742
1464	=back	1743	=back
1465		1744
1466	=head1 AUTHOR	1745	=head1 AUTHOR
1467		1746

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.71 by root, Mon Jan 9 23:18:49 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.71 by root, Mon Jan 9 23:18:49 2006 UTC vs.
Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC