[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.122 by root, Sat Jan 21 08:07:38 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	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	Intelligent selection. This extension tries to be more intelligent when	48	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	49	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	50	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
49	It also offers the following bindable event:	54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		71
		72	You can look at the source of the selection extension to see more
		73	interesting uses, such as parsing a line from beginning to end.
		74
		75	This extension also offers following bindable keyboard commands:
50		76
51	=over 4	77	=over 4
52		78
53	=item rot13	79	=item rot13
54		80
…		…
64	runtime.	90	runtime.
65		91
66	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
67		93
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	95	text into various other formats/action (such as uri unescaping, perl
		96	evaluation, web-browser starting etc.), depending on content.
		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
70		116
71	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
72		118
73	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
74	by a hotkey (default: C<M-s>). When in search mode, normal terminal	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	input/output is suspended.	121	input/output is suspended and a regex is displayed at the bottom of the
		122	screen.
76		123
77	C</> starts an incremental regex search, C<n> searches further, C<p> or	124	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	125	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>	126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
80	returns to the original position.	127	bottom. C<Escape> leaves search mode and returns to the point where search
		128	was started, while C<Enter> or C<Return> stay at the current position and
		129	additionally stores the first match in the current line into the primary
		130	selection.
81		131
82	=item digital-clock	132	=item selection-autotransform
83		133
84	Displays a digital clock using the built-in overlay.	134	This selection allows you to do automatic transforms on a selection
		135	whenever a selection is made.
		136
		137	It works by specifying perl snippets (most useful is a single C<s///>
		138	operator) that modify C<$_> as resources:
		139
		140	URxvt.selection-autotransform.0: transform
		141	URxvt.selection-autotransform.1: transform
		142	...
		143
		144	For example, the following will transform selections of the form
		145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		149
		150	And this example matches the same,but replaces it with vi-commands you can
		151	paste directly into your (vi :) editor:
		152
		153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
		166
		167	=item readline
		168
		169	A support package that tries to make editing with readline easier. At the
		170	moment, it reacts to clicking with the left mouse button by trying to
		171	move the text cursor to this position. It does so by generating as many
		172	cursor-left or cursor-right keypresses as required (the this only works
		173	for programs that correctly support wide characters).
		174
		175	To avoid too many false positives, this is only done when:
		176
		177	=over 4
		178
		179	=item - the mouse is on the same (multi-row-) line as the text cursor.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the text cursor is visible.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
		189
		190	=item tabbed
		191
		192	This transforms the terminal into a tabbar with additional terminals, that
		193	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		194	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		195	button per tab.
		196
		197	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		198	B<Shift-Right> will switch to the tab left or right of the current one,
		199	while B<Shift-Down> creates a new tab.
85		200
86	=item mark-urls	201	=item mark-urls
87		202
88	Uses per-line display filtering (C<on_line_update>) to underline urls.	203	Uses per-line display filtering (C<on_line_update>) to underline urls and
		204	make them clickable. When middle-clicked, the program specified in the
		205	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		206	the URL as first argument.
		207
		208	=item automove-background
		209
		210	This is basically a one-line extension that dynamically changes the background pixmap offset
		211	to the window position, in effect creating the same effect as pseudo transparency with
		212	a custom pixmap. No scaling is supported in this mode. Exmaple:
		213
		214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
89		215
90	=item block-graphics-to-ascii	216	=item block-graphics-to-ascii
91		217
92	A not very useful example of filtering all text output to the terminal,	218	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	219	by replacing all line-drawing characters (U+2500 .. U+259F) by a
94	similar-looking ascii character.	220	similar-looking ascii character.
95		221
		222	=item digital-clock
		223
		224	Displays a digital clock using the built-in overlay.
		225
96	=item example-refresh-hooks	226	=item example-refresh-hooks
97		227
98	Displays a very simple digital clock in the upper right corner of the	228	Displays a very simple digital clock in the upper right corner of the
99	window. Illustrates overwriting the refresh callbacks to create your own	229	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	230	overlays or changes.
101		231
		232	=item selection-pastebin
		233
		234	This is a little rarely useful extension that Uploads the selection as
		235	textfile to a remote site (or does other things). (The implementation is
		236	not currently secure for use in a multiuser environment as it writes to
		237	F</tmp> directly.).
		238
		239	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		240	i.e.
		241
		242	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		243
		244	Pressing this combination runs a command with C<%> replaced by the name of
		245	the textfile. This command can be set via a resource:
		246
		247	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		248
		249	And the default is likely not useful to anybody but the few people around
		250	here :)
		251
		252	The name of the textfile is the hex encoded md5 sum of the selection, so
		253	the same content should lead to the same filename.
		254
		255	After a successful upload the selection will be replaced by the text given
		256	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		257	for the filename):
		258
		259	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		260
102	=back	261	=back
		262
		263	=head1 API DOCUMENTATION
103		264
104	=head2 General API Considerations	265	=head2 General API Considerations
105		266
106	All objects (such as terminals, time watchers etc.) are typical	267	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	268	reference-to-hash objects. The hash can be used to store anything you
…		…
120	=over 4	281	=over 4
121		282
122	=item $text	283	=item $text
123		284
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	285	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.	286	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		287
127	=item $string	288	=item $string
128		289
129	A perl text string, with an emphasis on I<text>. It can store all unicode	290	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	291	characters and is to be distinguished with text encoded in a specific
…		…
176	called whenever the relevant event happens.	337	called whenever the relevant event happens.
177		338
178	The first argument passed to them is an extension oject as described in	339	The first argument passed to them is an extension oject as described in
179	the in the C<Extension Objects> section.	340	the in the C<Extension Objects> section.
180		341
181	B<All> of these hooks must return a boolean value. If it is true, then the	342	B<All> of these hooks must return a boolean value. If any of the called
182	event counts as being I<consumed>, and the invocation of other hooks is	343	hooks returns true, then the event counts as being I<consumed>, and the
183	skipped, and the relevant action might not be carried out by the C++ code.	344	relevant action might not be carried out by the C++ code.
184		345
185	I<< When in doubt, return a false value (preferably C<()>). >>	346	I<< When in doubt, return a false value (preferably C<()>). >>
186		347
187	=over 4	348	=over 4
188		349
189	=item on_init $term	350	=item on_init $term
190		351
191	Called after a new terminal object has been initialized, but before	352	Called after a new terminal object has been initialized, but before
192	windows are created or the command gets run. Most methods are unsafe to	353	windows are created or the command gets run. Most methods are unsafe to
193	call or deliver senseless data, as terminal size and other characteristics	354	call or deliver senseless data, as terminal size and other characteristics
194	have not yet been determined. You can safely query and change resources,	355	have not yet been determined. You can safely query and change resources
195	though.	356	and options, though. For many purposes the C<on_start> hook is a better
		357	place.
		358
		359	=item on_start $term
		360
		361	Called at the very end of initialisation of a new terminal, just before
		362	trying to map (display) the toplevel and returning to the mainloop.
		363
		364	=item on_destroy $term
		365
		366	Called whenever something tries to destroy terminal, before doing anything
		367	yet. If this hook returns true, then destruction is skipped, but this is
		368	rarely a good idea.
196		369
197	=item on_reset $term	370	=item on_reset $term
198		371
199	Called after the screen is "reset" for any reason, such as resizing or	372	Called after the screen is "reset" for any reason, such as resizing or
200	control sequences. Here is where you can react on changes to size-related	373	control sequences. Here is where you can react on changes to size-related
201	variables.	374	variables.
202		375
203	=item on_start $term	376	=item on_child_start $term, $pid
204		377
205	Called at the very end of initialisation of a new terminal, just before	378	Called just after the child process has been C<fork>ed.
206	returning to the mainloop.	379
		380	=item on_child_exit $term, $status
		381
		382	Called just after the child process has exited. C<$status> is the status
		383	from C<waitpid>.
207		384
208	=item on_sel_make $term, $eventtime	385	=item on_sel_make $term, $eventtime
209		386
210	Called whenever a selection has been made by the user, but before the	387	Called whenever a selection has been made by the user, but before the
211	selection text is copied, so changes to the beginning, end or type of the	388	selection text is copied, so changes to the beginning, end or type of the
…		…
225	=item on_sel_extend $term	402	=item on_sel_extend $term
226		403
227	Called whenever the user tries to extend the selection (e.g. with a double	404	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	405	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	406	should extend the selection itelf and return true to suppress the built-in
230	processing.	407	processing. This can happen multiple times, as long as the callback
		408	returns true, it will be called on every further click by the user and is
		409	supposed to enlarge the selection more and more, if possible.
231		410
232	See the F<selection> example extension.	411	See the F<selection> example extension.
233		412
234	=item on_view_change $term, $offset	413	=item on_view_change $term, $offset
235		414
…		…
302		481
303	Called whenever the user presses a key combination that has a	482	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>	483	C<perl:string> action bound to it (see description of the B<keysym>
305	resource in the @@RXVT_NAME@@(1) manpage).	484	resource in the @@RXVT_NAME@@(1) manpage).
306		485
		486	=item on_x_event $term, $event
		487
		488	Called on every X event received on the vt window (and possibly other
		489	windows). Should only be used as a last resort. Most event structure
		490	members are not passed.
		491
307	=item on_focus_in $term	492	=item on_focus_in $term
308		493
309	Called whenever the window gets the keyboard focus, before rxvt-unicode	494	Called whenever the window gets the keyboard focus, before rxvt-unicode
310	does focus in processing.	495	does focus in processing.
311		496
312	=item on_focus_out $term	497	=item on_focus_out $term
313		498
314	Called wheneever the window loses keyboard focus, before rxvt-unicode does	499	Called wheneever the window loses keyboard focus, before rxvt-unicode does
315	focus out processing.	500	focus out processing.
316		501
		502	=item on_configure_notify $term, $event
		503
		504	=item on_property_notify $term, $event
		505
317	=item on_key_press $term, $event, $keysym, $octets	506	=item on_key_press $term, $event, $keysym, $octets
318		507
319	=item on_key_release $term, $event, $keysym	508	=item on_key_release $term, $event, $keysym
320		509
321	=item on_button_press $term, $event	510	=item on_button_press $term, $event
…		…
330		519
331	Called whenever the corresponding X event is received for the terminal If	520	Called whenever the corresponding X event is received for the terminal If
332	the hook returns true, then the even will be ignored by rxvt-unicode.	521	the hook returns true, then the even will be ignored by rxvt-unicode.
333		522
334	The event is a hash with most values as named by Xlib (see the XEvent	523	The event is a hash with most values as named by Xlib (see the XEvent
335	manpage), with the additional members C<row> and C<col>, which are the row	524	manpage), with the additional members C<row> and C<col>, which are the
336	and column under the mouse cursor.	525	(real, not screen-based) row and column under the mouse cursor.
337		526
338	C<on_key_press> additionally receives the string rxvt-unicode would	527	C<on_key_press> additionally receives the string rxvt-unicode would
339	output, if any, in locale-specific encoding.	528	output, if any, in locale-specific encoding.
340		529
341	subwindow.	530	subwindow.
342		531
343	=back	532	=item on_client_message $term, $event
344		533
345	=head2 Variables in the C<urxvt> Package	534	=item on_wm_protocols $term, $event
346		535
347	=over 4	536	=item on_wm_delete_window $term, $event
348		537
349	=item $urxvt::TERM	538	Called when various types of ClientMessage events are received (all with
350		539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
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		540
453	=back	541	=back
454		542
455	=cut	543	=cut
456		544
…		…
462	use Scalar::Util ();	550	use Scalar::Util ();
463	use List::Util ();	551	use List::Util ();
464		552
465	our $VERSION = 1;	553	our $VERSION = 1;
466	our $TERM;	554	our $TERM;
		555	our @TERM_INIT;
		556	our @TERM_EXT;
467	our @HOOKNAME;	557	our @HOOKNAME;
468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	558	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
469	our %OPTION;	559	our %OPTION;
470		560
471	our $LIBDIR;	561	our $LIBDIR;
472	our $RESNAME;	562	our $RESNAME;
473	our $RESCLASS;	563	our $RESCLASS;
474	our $RXVTNAME;	564	our $RXVTNAME;
475		565
		566	our $NOCHAR = chr 0xfffe;
		567
		568	=head2 Variables in the C<urxvt> Package
		569
		570	=over 4
		571
		572	=item $urxvt::LIBDIR
		573
		574	The rxvt-unicode library directory, where, among other things, the perl
		575	modules and scripts are stored.
		576
		577	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		578
		579	The resource class and name rxvt-unicode uses to look up X resources.
		580
		581	=item $urxvt::RXVTNAME
		582
		583	The basename of the installed binaries, usually C<urxvt>.
		584
		585	=item $urxvt::TERM
		586
		587	The current terminal. This variable stores the current C<urxvt::term>
		588	object, whenever a callback/hook is executing.
		589
		590	=item @urxvt::TERM_INIT
		591
		592	All coderefs in this array will be called as methods of the next newly
		593	created C<urxvt::term> object (during the C<on_init> phase). The array
		594	gets cleared before the codereferences that were in it are being executed,
		595	so coderefs can push themselves onto it again if they so desire.
		596
		597	This complements to the perl-eval commandline option, but gets executed
		598	first.
		599
		600	=item @urxvt::TERM_EXT
		601
		602	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		603	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		604	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		605
		606	=back
		607
		608	=head2 Functions in the C<urxvt> Package
		609
		610	=over 4
		611
		612	=item urxvt::fatal $errormessage
		613
		614	Fatally aborts execution with the given error message. Avoid at all
		615	costs! The only time this is acceptable is when the terminal process
		616	starts up.
		617
		618	=item urxvt::warn $string
		619
		620	Calls C<rxvt_warn> with the given string which should not include a
		621	newline. The module also overwrites the C<warn> builtin with a function
		622	that calls this function.
		623
		624	Using this function has the advantage that its output ends up in the
		625	correct place, e.g. on stderr of the connecting urxvtc client.
		626
		627	Messages have a size limit of 1023 bytes currently.
		628
		629	=item $time = urxvt::NOW
		630
		631	Returns the "current time" (as per the event loop).
		632
		633	=item urxvt::CurrentTime
		634
		635	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		636	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		637	Button4Mask, Button5Mask, AnyModifier
		638
		639	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		640	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		641	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		642	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		643	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		644	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		645	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		646
		647	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		648	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		649	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		650	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		651	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		652	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		653	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		654
		655	Various constants for use in X calls and event processing.
		656
		657	=back
		658
		659	=head2 RENDITION
		660
		661	Rendition bitsets contain information about colour, font, font styles and
		662	similar information for each screen cell.
		663
		664	The following "macros" deal with changes in rendition sets. You should
		665	never just create a bitset, you should always modify an existing one,
		666	as they contain important information required for correct operation of
		667	rxvt-unicode.
		668
		669	=over 4
		670
		671	=item $rend = urxvt::DEFAULT_RSTYLE
		672
		673	Returns the default rendition, as used when the terminal is starting up or
		674	being reset. Useful as a base to start when creating renditions.
		675
		676	=item $rend = urxvt::OVERLAY_RSTYLE
		677
		678	Return the rendition mask used for overlays by default.
		679
		680	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		681
		682	Return the bit that enabled bold, italic, blink, reverse-video and
		683	underline, respectively. To enable such a style, just logically OR it into
		684	the bitset.
		685
		686	=item $foreground = urxvt::GET_BASEFG $rend
		687
		688	=item $background = urxvt::GET_BASEBG $rend
		689
		690	Return the foreground/background colour index, respectively.
		691
		692	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		693
		694	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		695
		696	Replace the foreground/background colour in the rendition mask with the
		697	specified one.
		698
		699	=item $value = urxvt::GET_CUSTOM $rend
		700
		701	Return the "custom" value: Every rendition has 5 bits for use by
		702	extensions. They can be set and changed as you like and are initially
		703	zero.
		704
		705	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		706
		707	Change the custom value.
		708
		709	=back
		710
		711	=cut
		712
476	BEGIN {	713	BEGIN {
477	urxvt->bootstrap;
478
479	# overwrite perl's warn	714	# overwrite perl's warn
480	*CORE::GLOBAL::warn = sub {	715	*CORE::GLOBAL::warn = sub {
481	my $msg = join "", @_;	716	my $msg = join "", @_;
482	$msg .= "\n"	717	$msg .= "\n"
483	unless $msg =~ /\n$/;	718	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	719	urxvt::warn ($msg);
485	};	720	};
486
487	delete $ENV{IFS};
488	delete $ENV{CDPATH};
489	delete $ENV{BASH_ENV};
490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
491	}	721	}
492		722
493	my @hook_count;
494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	723	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495		724
496	sub verbose {	725	sub verbose {
497	my ($level, $msg) = @_;	726	my ($level, $msg) = @_;
498	warn "$msg\n" if $level <= $verbosity;	727	warn "$msg\n" if $level <= $verbosity;
499	}	728	}
500		729
501	my $extension_pkg = "extension0000";
502	my %extension_pkg;	730	my %extension_pkg;
503		731
504	# load a single script into its own package, once only	732	# load a single script into its own package, once only
505	sub extension_package($) {	733	sub extension_package($) {
506	my ($path) = @_;	734	my ($path) = @_;
507		735
508	$extension_pkg{$path} \|\|= do {	736	$extension_pkg{$path} \|\|= do {
509	my $pkg = "urxvt::" . ($extension_pkg++);	737	$path =~ /([^\/\\]+)$/;
		738	my $pkg = $1;
		739	$pkg =~ s/[^[:word:]]/_/g;
		740	$pkg = "urxvt::ext::$pkg";
510		741
511	verbose 3, "loading extension '$path' into package '$pkg'";	742	verbose 3, "loading extension '$path' into package '$pkg'";
512		743
513	open my $fh, "<:raw", $path	744	open my $fh, "<:raw", $path
514	or die "$path: $!";	745	or die "$path: $!";
515		746
516	my $source = untaint	747	my $source =
517	"package $pkg; use strict; use utf8;\n"	748	"package $pkg; use strict; use utf8;\n"
518	. "use base urxvt::term::extension::;\n"
519	. "#line 1 \"$path\"\n{\n"	749	. "#line 1 \"$path\"\n{\n"
520	. (do { local $/; <$fh> })	750	. (do { local $/; <$fh> })
521	. "\n};\n1";	751	. "\n};\n1";
522		752
523	eval $source	753	eval $source
…		…
537	if ($htype == 0) { # INIT	767	if ($htype == 0) { # INIT
538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	768	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
539		769
540	my %ext_arg;	770	my %ext_arg;
541		771
		772	{
		773	my @init = @TERM_INIT;
		774	@TERM_INIT = ();
		775	$_->($TERM) for @init;
		776	my @pkg = @TERM_EXT;
		777	@TERM_EXT = ();
		778	$TERM->register_package ($_) for @pkg;
		779	}
		780
542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	781	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
543	if ($_ eq "default") {	782	if ($_ eq "default") {
544	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	783	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
545	} elsif (/^-(.*)$/) {	784	} elsif (/^-(.*)$/) {
546	delete $ext_arg{$1};	785	delete $ext_arg{$1};
547	} elsif (/^([^<]+)<(.*)>$/) {	786	} elsif (/^([^<]+)<(.*)>$/) {
…		…
572	if $verbosity >= 10;	811	if $verbosity >= 10;
573		812
574	keys %$cb;	813	keys %$cb;
575		814
576	while (my ($pkg, $cb) = each %$cb) {	815	while (my ($pkg, $cb) = each %$cb) {
577	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	816	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
578	and last;	817	$retval \|\|= $retval_;
579		818
580	if ($@) {	819	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	820	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	821	warn $@;
583	}	822	}
584	}	823	}
		824
		825	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		826	if $verbosity >= 11;
585	}	827	}
586		828
587	if ($htype == 1) { # DESTROY	829	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	830	# clear package objects
596	%$_ = () for values %{ $TERM->{_pkg} };	831	%$_ = () for values %{ $TERM->{_pkg} };
597		832
598	# clear package	833	# clear package
599	%$TERM = ();	834	%$TERM = ();
…		…
613	while (my ($name, $cb) = each %hook) {	848	while (my ($name, $cb) = each %hook) {
614	my $htype = $HOOKTYPE{uc $name};	849	my $htype = $HOOKTYPE{uc $name};
615	defined $htype	850	defined $htype
616	or Carp::croak "unsupported hook type '$name'";	851	or Carp::croak "unsupported hook type '$name'";
617		852
		853	$self->set_should_invoke ($htype, +1)
618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	854	unless exists $self->{term}{_hook}[$htype]{$pkg};
619	$hook_count[$htype]++
620	or urxvt::set_should_invoke $htype, 1;
621	}
622		855
623	$self->{term}{_hook}[$htype]{$pkg} = $cb;	856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
624	}	857	}
625	}	858	}
626		859
…		…
631	for my $name (@hook) {	864	for my $name (@hook) {
632	my $htype = $HOOKTYPE{uc $name};	865	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	866	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	867	or Carp::croak "unsupported hook type '$name'";
635		868
		869	$self->set_should_invoke ($htype, -1)
636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	870	if delete $self->{term}{_hook}[$htype]{$pkg};
637	--$hook_count[$htype]
638	or urxvt::set_should_invoke $htype, 0;
639	}
640	}	871	}
641	}	872	}
642		873
643	our $AUTOLOAD;	874	our $AUTOLOAD;
644		875
…		…
675		906
676	=head2 The C<urxvt::anyevent> Class	907	=head2 The C<urxvt::anyevent> Class
677		908
678	The sole purpose of this class is to deliver an interface to the	909	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	910	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	911	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	912	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	913	is that you cannot use blocking APIs, but the non-blocking variant should
		914	work.
683		915
684	=cut	916	=cut
685		917
686	our $VERSION = 1;	918	our $VERSION = 1;
687		919
…		…
749	# find on_xxx subs in the package and register them	981	# find on_xxx subs in the package and register them
750	# as hooks	982	# as hooks
751	sub register_package {	983	sub register_package {
752	my ($self, $pkg, $argv) = @_;	984	my ($self, $pkg, $argv) = @_;
753		985
		986	no strict 'refs';
		987
		988	urxvt::verbose 6, "register package $pkg to $self";
		989
		990	@{"$pkg\::ISA"} = urxvt::term::extension::;
		991
754	my $proxy = bless {	992	my $proxy = bless {
755	_pkg => $pkg,	993	_pkg => $pkg,
756	argv => $argv,	994	argv => $argv,
757	}, $pkg;	995	}, $pkg;
758	Scalar::Util::weaken ($proxy->{term} = $self);	996	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
764	$proxy->enable ($name => $ref);	1002	$proxy->enable ($name => $ref);
765	}	1003	}
766	}	1004	}
767	}	1005	}
768		1006
		1007	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1008
		1009	Creates a new terminal, very similar as if you had started it with system
		1010	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1011	hash which defines the environment of the new terminal.
		1012
		1013	Croaks (and probably outputs an error message) if the new instance
		1014	couldn't be created. Returns C<undef> if the new instance didn't
		1015	initialise perl, and the terminal object otherwise. The C<init> and
		1016	C<start> hooks will be called during this call.
		1017
		1018	=cut
		1019
		1020	sub new {
		1021	my ($class, $env, @args) = @_;
		1022
		1023	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		1024	}
		1025
769	=item $term->destroy	1026	=item $term->destroy
770		1027
771	Destroy the terminal object (close the window, free resources etc.).	1028	Destroy the terminal object (close the window, free resources
		1029	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1030	watchers (timers, io watchers) are still active.
		1031
		1032	=item $term->exec_async ($cmd[, @args])
		1033
		1034	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1035	("starts") programs in the background. This function takes care of setting
		1036	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1037	be preferred over explicit calls to C<exec> or C<system>.
		1038
		1039	Returns the pid of the subprocess or C<undef> on error.
		1040
		1041	=cut
		1042
		1043	sub exec_async {
		1044	my $self = shift;
		1045
		1046	my $pid = fork;
		1047
		1048	return $pid
		1049	if !defined $pid or $pid;
		1050
		1051	%ENV = %{ $self->env };
		1052
		1053	exec @_;
		1054	urxvt::_exit 255;
		1055	}
772		1056
773	=item $isset = $term->option ($optval[, $set])	1057	=item $isset = $term->option ($optval[, $set])
774		1058
775	Returns true if the option specified by C<$optval> is enabled, and	1059	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	1060	optionally change it. All option values are stored by name in the hash
…		…
779	Here is a a likely non-exhaustive list of option names, please see the	1063	Here is a a likely non-exhaustive list of option names, please see the
780	source file F</src/optinc.h> to see the actual list:	1064	source file F</src/optinc.h> to see the actual list:
781		1065
782	borderLess console cursorBlink cursorUnderline hold iconic insecure	1066	borderLess console cursorBlink cursorUnderline hold iconic insecure
783	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1067	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
784	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1068	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
785	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1069	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
786	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1070	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
787	tripleclickwords utmpInhibit visualBell	1071	transparent tripleclickwords utmpInhibit visualBell
788		1072
789	=item $value = $term->resource ($name[, $newval])	1073	=item $value = $term->resource ($name[, $newval])
790		1074
791	Returns the current resource value associated with a given name and	1075	Returns the current resource value associated with a given name and
792	optionally sets a new value. Setting values is most useful in the C<init>	1076	optionally sets a new value. Setting values is most useful in the C<init>
…		…
809		1093
810	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1094	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
811	borderLess color cursorBlink cursorUnderline cutchars delete_key	1095	borderLess color cursorBlink cursorUnderline cutchars delete_key
812	display_name embed ext_bwidth fade font geometry hold iconName	1096	display_name embed ext_bwidth fade font geometry hold iconName
813	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1097	imFont imLocale inputMethod insecure int_bwidth intensityStyles
814	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1098	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
815	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1099	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
816	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1100	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
817	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1101	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
818	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1102	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
819	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1103	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
820	shade term_name title transparent transparent_all tripleclickwords	1104	secondaryScreen secondaryScroll selectstyle shade term_name title
821	utmpInhibit visualBell	1105	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1106	visualBell
822		1107
823	=cut	1108	=cut
824		1109
825	sub resource($$;$) {	1110	sub resource($$;$) {
826	my ($self, $name) = (shift, shift);	1111	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1112	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	1113	&urxvt::term::_resource
829	}	1114	}
830		1115
		1116	=item $value = $term->x_resource ($pattern)
		1117
		1118	Returns the X-Resource for the given pattern, excluding the program or
		1119	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1120	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1121	resource with that pattern exists.
		1122
		1123	This method should only be called during the C<on_start> hook, as there is
		1124	only one resource database per display, and later invocations might return
		1125	the wrong resources.
		1126
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1127	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		1128
833	Adds a keymap translation exactly as specified via a resource. See the	1129	Adds a keymap translation exactly as specified via a resource. See the
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1130	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835		1131
…		…
850	=item ($row, $col) = $term->selection_end ([$row, $col])	1146	=item ($row, $col) = $term->selection_end ([$row, $col])
851		1147
852	Return the current values of the selection mark, begin or end positions,	1148	Return the current values of the selection mark, begin or end positions,
853	and optionally set them to new values.	1149	and optionally set them to new values.
854		1150
		1151	=item $term->selection_make ($eventtime[, $rectangular])
		1152
		1153	Tries to make a selection as set by C<selection_beg> and
		1154	C<selection_end>. If C<$rectangular> is true (default: false), a
		1155	rectangular selection will be made. This is the prefered function to make
		1156	a selection.
		1157
855	=item $success = $term->selection_grab ($eventtime)	1158	=item $success = $term->selection_grab ($eventtime)
856		1159
857	Try to request the primary selection from the server (for example, as set	1160	Try to request the primary selection text from the server (for example, as
858	by the next method).	1161	set by the next method). No visual feedback will be given. This function
		1162	is mostly useful from within C<on_sel_grab> hooks.
859		1163
860	=item $oldtext = $term->selection ([$newtext])	1164	=item $oldtext = $term->selection ([$newtext])
861		1165
862	Return the current selection text and optionally replace it by C<$newtext>.	1166	Return the current selection text and optionally replace it by C<$newtext>.
863		1167
…		…
956	Convert the given locale-encoded octets into a perl string.	1260	Convert the given locale-encoded octets into a perl string.
957		1261
958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1262	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959		1263
960	XORs the rendition values in the given span with the provided value	1264	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	1265	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962	to the selection.	1266	refresh hooks to provide effects similar to the selection.
963		1267
964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1268	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965		1269
966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1270	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1271	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	1272	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
969	it instead.	1273	it instead. Both styles I<MUST NOT> contain font styles.
970		1274
971	=item $term->scr_bell	1275	=item $term->scr_bell
972		1276
973	Ring the bell!	1277	Ring the bell!
974		1278
…		…
981		1285
982	Normally its not a good idea to use this function, as programs might be	1286	Normally its not a good idea to use this function, as programs might be
983	confused by changes in cursor position or scrolling. Its useful inside a	1287	confused by changes in cursor position or scrolling. Its useful inside a
984	C<on_add_lines> hook, though.	1288	C<on_add_lines> hook, though.
985		1289
		1290	=item $term->scr_change_screen ($screen)
		1291
		1292	Switch to given screen - 0 primary, 1 secondary.
		1293
986	=item $term->cmd_parse ($octets)	1294	=item $term->cmd_parse ($octets)
987		1295
988	Similar to C<scr_add_lines>, but the argument must be in the	1296	Similar to C<scr_add_lines>, but the argument must be in the
989	locale-specific encoding of the terminal and can contain command sequences	1297	locale-specific encoding of the terminal and can contain command sequences
990	(escape codes) that will be interpreted.	1298	(escape codes) that will be interpreted.
…		…
1008		1316
1009	=item $windowid = $term->vt	1317	=item $windowid = $term->vt
1010		1318
1011	Return the window id of the terminal window.	1319	Return the window id of the terminal window.
1012		1320
		1321	=item $term->vt_emask_add ($x_event_mask)
		1322
		1323	Adds the specified events to the vt event mask. Useful e.g. when you want
		1324	to receive pointer events all the times:
		1325
		1326	$term->vt_emask_add (urxvt::PointerMotionMask);
		1327
1013	=item $window_width = $term->width	1328	=item $window_width = $term->width
1014		1329
1015	=item $window_height = $term->height	1330	=item $window_height = $term->height
1016		1331
1017	=item $font_width = $term->fwidth	1332	=item $font_width = $term->fwidth
…		…
1030		1345
1031	=item $max_scrollback = $term->saveLines	1346	=item $max_scrollback = $term->saveLines
1032		1347
1033	=item $nrow_plus_saveLines = $term->total_rows	1348	=item $nrow_plus_saveLines = $term->total_rows
1034		1349
1035	=item $lines_in_scrollback = $term->nsaved	1350	=item $topmost_scrollback_row = $term->top_row
1036		1351
1037	Return various integers describing terminal characteristics.	1352	Return various integers describing terminal characteristics.
1038		1353
		1354	=item $x_display = $term->display_id
		1355
		1356	Return the DISPLAY used by rxvt-unicode.
		1357
1039	=item $lc_ctype = $term->locale	1358	=item $lc_ctype = $term->locale
1040		1359
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1360	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1361
1043	=item $x_display = $term->display_id	1362	=item $env = $term->env
1044		1363
1045	Return the DISPLAY used by rxvt-unicode.	1364	Returns a copy of the environment in effect for the terminal as a hashref
		1365	similar to C<\%ENV>.
		1366
		1367	=cut
		1368
		1369	sub env {
		1370	if (my $env = $_[0]->_env) {
		1371	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1372	} else {
		1373	+{ %ENV }
		1374	}
		1375	}
1046		1376
1047	=item $modifiermask = $term->ModLevel3Mask	1377	=item $modifiermask = $term->ModLevel3Mask
1048		1378
1049	=item $modifiermask = $term->ModMetaMask	1379	=item $modifiermask = $term->ModMetaMask
1050		1380
1051	=item $modifiermask = $term->ModNumLockMask	1381	=item $modifiermask = $term->ModNumLockMask
1052		1382
1053	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1383	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.	1384	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1055		1385
		1386	=item $screen = $term->current_screen
		1387
		1388	Returns the currently displayed screen (0 primary, 1 secondary).
		1389
		1390	=item $cursor_is_hidden = $term->hidden_cursor
		1391
		1392	Returns wether the cursor is currently hidden or not.
		1393
1056	=item $view_start = $term->view_start ([$newvalue])	1394	=item $view_start = $term->view_start ([$newvalue])
1057		1395
1058	Returns the negative row number of the topmost line. Minimum value is	1396	Returns the row number of the topmost displayed line. Maximum value is
1059	C<0>, which displays the normal terminal contents. Larger values scroll	1397	C<0>, which displays the normal terminal contents. Lower values scroll
1060	this many lines into the scrollback buffer.	1398	this many lines into the scrollback buffer.
1061		1399
1062	=item $term->want_refresh	1400	=item $term->want_refresh
1063		1401
1064	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1402	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1078	If C<$new_text> is specified, it will replace characters in the current	1416	If C<$new_text> is specified, it will replace characters in the current
1079	line, starting at column C<$start_col> (default C<0>), which is useful	1417	line, starting at column C<$start_col> (default C<0>), which is useful
1080	to replace only parts of a line. The font index in the rendition will	1418	to replace only parts of a line. The font index in the rendition will
1081	automatically be updated.	1419	automatically be updated.
1082		1420
1083	C<$text> is in a special encoding: tabs and wide characters that use more	1421	C<$text> is in a special encoding: tabs and wide characters that use
1084	than one cell when displayed are padded with urxvt::NOCHAR characters	1422	more than one cell when displayed are padded with C<$urxvt::NOCHAR>
1085	(C<chr 65535>). Characters with combining characters and other characters	1423	characters. Characters with combining characters and other characters that
1086	that do not fit into the normal tetx encoding will be replaced with	1424	do not fit into the normal tetx encoding will be replaced with characters
1087	characters in the private use area.	1425	in the private use area.
1088		1426
1089	You have to obey this encoding when changing text. The advantage is	1427	You have to obey this encoding when changing text. The advantage is
1090	that C<substr> and similar functions work on screen cells and not on	1428	that C<substr> and similar functions work on screen cells and not on
1091	characters.	1429	characters.
1092		1430
…		…
1143	Return the row number of the first/last row of the line, respectively.	1481	Return the row number of the first/last row of the line, respectively.
1144		1482
1145	=item $offset = $line->offset_of ($row, $col)	1483	=item $offset = $line->offset_of ($row, $col)
1146		1484
1147	Returns the character offset of the given row\|col pair within the logical	1485	Returns the character offset of the given row\|col pair within the logical
1148	line.	1486	line. Works for rows outside the line, too, and returns corresponding
		1487	offsets outside the string.
1149		1488
1150	=item ($row, $col) = $line->coord_of ($offset)	1489	=item ($row, $col) = $line->coord_of ($offset)
1151		1490
1152	Translates a string offset into terminal coordinates again.	1491	Translates a string offset into terminal coordinates again.
1153		1492
…		…
1266		1605
1267	Calls XUngrab for the most recent grab. Is called automatically on	1606	Calls XUngrab for the most recent grab. Is called automatically on
1268	evaluation errors, as it is better to lose the grab in the error case as	1607	evaluation errors, as it is better to lose the grab in the error case as
1269	the session.	1608	the session.
1270		1609
		1610	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1611
		1612	=item $atom_name = $term->XGetAtomName ($atom)
		1613
		1614	=item @atoms = $term->XListProperties ($window)
		1615
		1616	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1617
		1618	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1619
		1620	=item $term->XDeleteProperty ($window, $property)
		1621
		1622	=item $window = $term->DefaultRootWindow
		1623
		1624	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1625
		1626	=item $term->XMapWindow ($window)
		1627
		1628	=item $term->XUnmapWindow ($window)
		1629
		1630	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1631
		1632	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1633
		1634	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1635
		1636	Various X or X-related functions. The C<$term> object only serves as
		1637	the source of the display, otherwise those functions map more-or-less
		1638	directory onto the X functions of the same name.
		1639
1271	=back	1640	=back
1272		1641
1273	=cut	1642	=cut
1274		1643
1275	package urxvt::popup;	1644	package urxvt::popup;
…		…
1289		1658
1290	$item->{render} \|\|= sub { $_[0]{text} };	1659	$item->{render} \|\|= sub { $_[0]{text} };
1291		1660
1292	push @{ $self->{item} }, $item;	1661	push @{ $self->{item} }, $item;
1293	}	1662	}
		1663
		1664	=item $popup->add_title ($title)
		1665
		1666	Adds a non-clickable title to the popup.
		1667
		1668	=cut
		1669
		1670	sub add_title {
		1671	my ($self, $title) = @_;
		1672
		1673	$self->add_item ({
		1674	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1675	text => $title,
		1676	activate => sub { },
		1677	});
		1678	}
		1679
		1680	=item $popup->add_separator ([$sepchr])
		1681
		1682	Creates a separator, optionally using the character given as C<$sepchr>.
		1683
		1684	=cut
1294		1685
1295	sub add_separator {	1686	sub add_separator {
1296	my ($self, $sep) = @_;	1687	my ($self, $sep) = @_;
1297		1688
1298	$sep \|\|= "=";	1689	$sep \|\|= "=";
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1694	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1695	activate => sub { },
1305	});	1696	});
1306	}	1697	}
1307		1698
1308	sub add_title {	1699	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1700
1311	$self->add_item ({	1701	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" },	1702	selected.
1313	text => $title,	1703
1314	activate => sub { },	1704	=cut
1315	});
1316	}
1317		1705
1318	sub add_button {	1706	sub add_button {
1319	my ($self, $text, $cb) = @_;	1707	my ($self, $text, $cb) = @_;
1320		1708
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1709	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	1710	}
		1711
		1712	=item $popup->add_toggle ($text, $cb, $initial_value)
		1713
		1714	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1715	whenever it gets toggled, with a boolean indicating its value as its first
		1716	argument.
		1717
		1718	=cut
1323		1719
1324	sub add_toggle {	1720	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1721	my ($self, $text, $cb, $value) = @_;
1326		1722
1327	my $item; $item = {	1723	my $item; $item = {
1328	type => "button",	1724	type => "button",
1329	text => " $text",	1725	text => " $text",
1330	value => $value,	1726	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1727	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1728	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1729	};
1334		1730
1335	$self->add_item ($item);	1731	$self->add_item ($item);
1336	}	1732	}
		1733
		1734	=item $popup->show
		1735
		1736	Displays the popup (which is initially hidden).
		1737
		1738	=cut
1337		1739
1338	sub show {	1740	sub show {
1339	my ($self) = @_;	1741	my ($self) = @_;
1340		1742
1341	local $urxvt::popup::self = $self;	1743	local $urxvt::popup::self = $self;
1342		1744
		1745	my $env = $self->{term}->env;
		1746	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1747	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1748	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1749
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1750	urxvt::term->new ($env, "popup",
		1751	"--perl-lib" => "", "--perl-ext-common" => "",
		1752	"-pty-fd" => -1, "-sl" => 0,
		1753	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1346	"--transient-for" => $self->{term}->parent,	1754	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1755	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1756	"-pe" => "urxvt-popup")
1349	or die "unable to create popup window\n";	1757	or die "unable to create popup window\n";
1350	}	1758	}
1351		1759
1352	sub DESTROY {	1760	sub DESTROY {
1353	my ($self) = @_;	1761	my ($self) = @_;
1354		1762
1355	delete $self->{term}{_destroy}{$self};	1763	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1764	$self->{term}->ungrab;
1357	}	1765	}
		1766
		1767	=back
		1768
		1769	=cut
		1770
		1771	package urxvt::watcher;
		1772
		1773	@urxvt::timer::ISA = __PACKAGE__;
		1774	@urxvt::iow::ISA = __PACKAGE__;
		1775	@urxvt::pw::ISA = __PACKAGE__;
		1776	@urxvt::iw::ISA = __PACKAGE__;
1358		1777
1359	=head2 The C<urxvt::timer> Class	1778	=head2 The C<urxvt::timer> Class
1360		1779
1361	This class implements timer watchers/events. Time is represented as a	1780	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1781	fractional number of seconds since the epoch. Example:
…		…
1400	Start the timer.	1819	Start the timer.
1401		1820
1402	=item $timer = $timer->start ($tstamp)	1821	=item $timer = $timer->start ($tstamp)
1403		1822
1404	Set the event trigger time to C<$tstamp> and start the timer.	1823	Set the event trigger time to C<$tstamp> and start the timer.
		1824
		1825	=item $timer = $timer->after ($delay)
		1826
		1827	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1405		1828
1406	=item $timer = $timer->stop	1829	=item $timer = $timer->stop
1407		1830
1408	Stop the timer.	1831	Stop the timer.
1409		1832
…		…
1456		1879
1457	Stop watching for events on the given filehandle.	1880	Stop watching for events on the given filehandle.
1458		1881
1459	=back	1882	=back
1460		1883
		1884	=head2 The C<urxvt::iw> Class
		1885
		1886	This class implements idle watchers, that get called automatically when
		1887	the process is idle. They should return as fast as possible, after doing
		1888	some useful work.
		1889
		1890	=over 4
		1891
		1892	=item $iw = new urxvt::iw
		1893
		1894	Create a new idle watcher object in stopped state.
		1895
		1896	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1897
		1898	Set the callback to be called when the watcher triggers.
		1899
		1900	=item $timer = $timer->start
		1901
		1902	Start the watcher.
		1903
		1904	=item $timer = $timer->stop
		1905
		1906	Stop the watcher.
		1907
		1908	=back
		1909
		1910	=head2 The C<urxvt::pw> Class
		1911
		1912	This class implements process watchers. They create an event whenever a
		1913	process exits, after which they stop automatically.
		1914
		1915	my $pid = fork;
		1916	...
		1917	$term->{pw} = urxvt::pw
		1918	->new
		1919	->start ($pid)
		1920	->cb (sub {
		1921	my ($pw, $exit_status) = @_;
		1922	...
		1923	});
		1924
		1925	=over 4
		1926
		1927	=item $pw = new urxvt::pw
		1928
		1929	Create a new process watcher in stopped state.
		1930
		1931	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1932
		1933	Set the callback to be called when the timer triggers.
		1934
		1935	=item $pw = $timer->start ($pid)
		1936
		1937	Tells the wqtcher to start watching for process C<$pid>.
		1938
		1939	=item $pw = $pw->stop
		1940
		1941	Stop the watcher.
		1942
		1943	=back
		1944
1461	=head1 ENVIRONMENT	1945	=head1 ENVIRONMENT
1462		1946
1463	=head2 URXVT_PERL_VERBOSITY	1947	=head2 URXVT_PERL_VERBOSITY
1464		1948
1465	This variable controls the verbosity level of the perl extension. Higher	1949	This variable controls the verbosity level of the perl extension. Higher
…		…
1469		1953
1470	=item == 0 - fatal messages	1954	=item == 0 - fatal messages
1471		1955
1472	=item >= 3 - script loading and management	1956	=item >= 3 - script loading and management
1473		1957
1474	=item >=10 - all events received	1958	=item >=10 - all called hooks
		1959
		1960	=item >=11 - hook reutrn values
1475		1961
1476	=back	1962	=back
1477		1963
1478	=head1 AUTHOR	1964	=head1 AUTHOR
1479		1965

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.122 by root, Sat Jan 21 08:07:38 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.122 by root, Sat Jan 21 08:07:38 2006 UTC