ViewVC Help

View File | Revision Log | Show Annotations | Download File

/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.130 by root, Wed Jan 25 15:32:48 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	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
		78
		79	You can look at the source of the selection extension to see more
		80	interesting uses, such as parsing a line from beginning to end.
		81
		82	This extension also offers following bindable keyboard commands:
50		83
51	=over 4	84	=over 4
52		85
53	=item rot13	86	=item rot13
54		87
…		…
64	runtime.	97	runtime.
65		98
66	=item selection-popup (enabled by default)	99	=item selection-popup (enabled by default)
67		100
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	101	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	102	text into various other formats/action (such as uri unescaping, perl
		103	evaluation, web-browser starting etc.), depending on content.
		104
		105	Other extensions can extend this popup menu by pushing a code reference
		106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		107	popup is displayed.
		108
		109	It's sole argument is the popup menu, which can be modified. The selection
		110	is in C<$_>, which can be used to decide wether to add something or not.
		111	It should either return nothing or a string and a code reference. The
		112	string will be used as button text and the code reference will be called
		113	when the button gets activated and should transform C<$_>.
		114
		115	The following will add an entry C<a to b> that transforms all C<a>s in
		116	the selection to C<b>s, but only if the selection currently contains any
		117	C<a>s:
		118
		119	push @{ $self->{term}{selection_popup_hook} }, sub {
		120	/a/ ? ("a to be" => sub { s/a/b/g }
		121	: ()
		122	};
70		123
71	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
72		125
73	Adds regex search functionality to the scrollback buffer, triggered	126	Adds regex search functionality to the scrollback buffer, triggered
74	by a hotkey (default: C<M-s>). When in search mode, normal terminal	127	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	input/output is suspended.	128	input/output is suspended and a regex is displayed at the bottom of the
		129	screen.
76		130
77	C</> starts an incremental regex search, C<n> searches further, C<p> or	131	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	132	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>	133	search upwards/downwards in the scrollback buffer, C<End> jumps to the
80	returns to the original position.	134	bottom. C<Escape> leaves search mode and returns to the point where search
		135	was started, while C<Enter> or C<Return> stay at the current position and
		136	additionally stores the first match in the current line into the primary
		137	selection.
81		138
82	=item digital-clock	139	=item readline (enabled by default)
83		140
84	Displays a digital clock using the built-in overlay.	141	A support package that tries to make editing with readline easier. At the
		142	moment, it reacts to clicking with the left mouse button by trying to
		143	move the text cursor to this position. It does so by generating as many
		144	cursor-left or cursor-right keypresses as required (the this only works
		145	for programs that correctly support wide characters).
		146
		147	To avoid too many false positives, this is only done when:
		148
		149	=over 4
		150
		151	=item - the tty is in ICANON state.
		152
		153	=item - the text cursor is visible.
		154
		155	=item - the primary screen is currently being displayed.
		156
		157	=item - the mouse is on the same (multi-row-) line as the text cursor.
		158
		159	=back
		160
		161	The normal selection mechanism isn't disabled, so quick successive clicks
		162	might interfere with selection creation in harmless ways.
		163
		164	=item selection-autotransform
		165
		166	This selection allows you to do automatic transforms on a selection
		167	whenever a selection is made.
		168
		169	It works by specifying perl snippets (most useful is a single C<s///>
		170	operator) that modify C<$_> as resources:
		171
		172	URxvt.selection-autotransform.0: transform
		173	URxvt.selection-autotransform.1: transform
		174	...
		175
		176	For example, the following will transform selections of the form
		177	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		178	$word>:
		179
		180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		181
		182	And this example matches the same,but replaces it with vi-commands you can
		183	paste directly into your (vi :) editor:
		184
		185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		186
		187	Of course, this can be modified to suit your needs and your editor :)
		188
		189	To expand the example above to typical perl error messages ("XXX at
		190	FILENAME line YYY."), you need a slightly more elaborate solution:
		191
		192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		194
		195	The first line tells the selection code to treat the unchanging part of
		196	every error message as a selection pattern, and the second line transforms
		197	the message into vi commands to load the file.
		198
		199	=item tabbed
		200
		201	This transforms the terminal into a tabbar with additional terminals, that
		202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		204	button per tab.
		205
		206	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		207	B<Shift-Right> will switch to the tab left or right of the current one,
		208	while B<Shift-Down> creates a new tab.
85		209
86	=item mark-urls	210	=item mark-urls
87		211
88	Uses per-line display filtering (C<on_line_update>) to underline urls.	212	Uses per-line display filtering (C<on_line_update>) to underline urls and
		213	make them clickable. When middle-clicked, the program specified in the
		214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		215	the URL as first argument.
		216
		217	=item xim-onthespot
		218
		219	This (experimental) perl extension implements OnTheSpot editing. It does
		220	not work perfectly, and some input methods don't seem to work well with
		221	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		222	kinput2.
		223
		224	You enable it by specifying this extension and a preedit style of
		225	C<OnTheSpot>, i.e.:
		226
		227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		228
		229	=item automove-background
		230
		231	This is basically a one-line extension that dynamically changes the background pixmap offset
		232	to the window position, in effect creating the same effect as pseudo transparency with
		233	a custom pixmap. No scaling is supported in this mode. Exmaple:
		234
		235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
89		236
90	=item block-graphics-to-ascii	237	=item block-graphics-to-ascii
91		238
92	A not very useful example of filtering all text output to the terminal,	239	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	240	by replacing all line-drawing characters (U+2500 .. U+259F) by a
94	similar-looking ascii character.	241	similar-looking ascii character.
95		242
		243	=item digital-clock
		244
		245	Displays a digital clock using the built-in overlay.
		246
		247	=item remote-clipboard
		248
		249	Somewhat of a misnomer, this extension adds two menu entries to the
		250	selection popup that allows one ti run external commands to store the
		251	selection somewhere and fetch it again.
		252
		253	We use it to implement a "distributed selection mechanism", which just
		254	means that one command uploads the file to a remote server, and another
		255	reads it.
		256
		257	The commands can be set using the C<URxvt.remote-selection.store> and
		258	C<URxvt.remote-selection.fetch> resources. The first should read the
		259	selection to store from STDIN (always in UTF-8), the second should provide
		260	the selection data on STDOUT (also in UTF-8).
		261
		262	The defaults (which are likely useless to you) use rsh and cat:
		263
		264	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		265	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		266
		267	=item selection-pastebin
		268
		269	This is a little rarely useful extension that Uploads the selection as
		270	textfile to a remote site (or does other things). (The implementation is
		271	not currently secure for use in a multiuser environment as it writes to
		272	F</tmp> directly.).
		273
		274	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		275	i.e.
		276
		277	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		278
		279	Pressing this combination runs a command with C<%> replaced by the name of
		280	the textfile. This command can be set via a resource:
		281
		282	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		283
		284	And the default is likely not useful to anybody but the few people around
		285	here :)
		286
		287	The name of the textfile is the hex encoded md5 sum of the selection, so
		288	the same content should lead to the same filename.
		289
		290	After a successful upload the selection will be replaced by the text given
		291	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		292	for the filename):
		293
		294	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		295
96	=item example-refresh-hooks	296	=item example-refresh-hooks
97		297
98	Displays a very simple digital clock in the upper right corner of the	298	Displays a very simple digital clock in the upper right corner of the
99	window. Illustrates overwriting the refresh callbacks to create your own	299	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	300	overlays or changes.
101		301
102	=back	302	=back
		303
		304	=head1 API DOCUMENTATION
103		305
104	=head2 General API Considerations	306	=head2 General API Considerations
105		307
106	All objects (such as terminals, time watchers etc.) are typical	308	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	309	reference-to-hash objects. The hash can be used to store anything you
…		…
120	=over 4	322	=over 4
121		323
122	=item $text	324	=item $text
123		325
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	326	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.	327	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		328
127	=item $string	329	=item $string
128		330
129	A perl text string, with an emphasis on I<text>. It can store all unicode	331	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	332	characters and is to be distinguished with text encoded in a specific
…		…
176	called whenever the relevant event happens.	378	called whenever the relevant event happens.
177		379
178	The first argument passed to them is an extension oject as described in	380	The first argument passed to them is an extension oject as described in
179	the in the C<Extension Objects> section.	381	the in the C<Extension Objects> section.
180		382
181	B<All> of these hooks must return a boolean value. If it is true, then the	383	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	384	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.	385	relevant action might not be carried out by the C++ code.
184		386
185	I<< When in doubt, return a false value (preferably C<()>). >>	387	I<< When in doubt, return a false value (preferably C<()>). >>
186		388
187	=over 4	389	=over 4
188		390
189	=item on_init $term	391	=item on_init $term
190		392
191	Called after a new terminal object has been initialized, but before	393	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	394	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	395	call or deliver senseless data, as terminal size and other characteristics
194	have not yet been determined. You can safely query and change resources,	396	have not yet been determined. You can safely query and change resources
195	though.	397	and options, though. For many purposes the C<on_start> hook is a better
		398	place.
		399
		400	=item on_start $term
		401
		402	Called at the very end of initialisation of a new terminal, just before
		403	trying to map (display) the toplevel and returning to the mainloop.
		404
		405	=item on_destroy $term
		406
		407	Called whenever something tries to destroy terminal, when the terminal is
		408	still fully functional (not for long, though).
196		409
197	=item on_reset $term	410	=item on_reset $term
198		411
199	Called after the screen is "reset" for any reason, such as resizing or	412	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	413	control sequences. Here is where you can react on changes to size-related
201	variables.	414	variables.
202		415
203	=item on_start $term	416	=item on_child_start $term, $pid
204		417
205	Called at the very end of initialisation of a new terminal, just before	418	Called just after the child process has been C<fork>ed.
206	returning to the mainloop.	419
		420	=item on_child_exit $term, $status
		421
		422	Called just after the child process has exited. C<$status> is the status
		423	from C<waitpid>.
207		424
208	=item on_sel_make $term, $eventtime	425	=item on_sel_make $term, $eventtime
209		426
210	Called whenever a selection has been made by the user, but before the	427	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	428	selection text is copied, so changes to the beginning, end or type of the
…		…
225	=item on_sel_extend $term	442	=item on_sel_extend $term
226		443
227	Called whenever the user tries to extend the selection (e.g. with a double	444	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	445	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	446	should extend the selection itelf and return true to suppress the built-in
230	processing.	447	processing. This can happen multiple times, as long as the callback
		448	returns true, it will be called on every further click by the user and is
		449	supposed to enlarge the selection more and more, if possible.
231		450
232	See the F<selection> example extension.	451	See the F<selection> example extension.
233		452
234	=item on_view_change $term, $offset	453	=item on_view_change $term, $offset
235		454
…		…
296		515
297	=item on_refresh_end $term	516	=item on_refresh_end $term
298		517
299	Called just after the screen gets redrawn. See C<on_refresh_begin>.	518	Called just after the screen gets redrawn. See C<on_refresh_begin>.
300		519
301	=item on_keyboard_command $term, $string	520	=item on_user_command $term, $string
302		521
303	Called whenever the user presses a key combination that has a	522	Called whenever the a user-configured event is being activated (e.g. via
304	C<perl:string> action bound to it (see description of the B<keysym>	523	a C<perl:string> action bound to a key, see description of the B<keysym>
305	resource in the @@RXVT_NAME@@(1) manpage).	524	resource in the @@RXVT_NAME@@(1) manpage).
		525
		526	The event is simply the action string. This interface is assumed to change
		527	slightly in the future.
		528
		529	=item on_x_event $term, $event
		530
		531	Called on every X event received on the vt window (and possibly other
		532	windows). Should only be used as a last resort. Most event structure
		533	members are not passed.
306		534
307	=item on_focus_in $term	535	=item on_focus_in $term
308		536
309	Called whenever the window gets the keyboard focus, before rxvt-unicode	537	Called whenever the window gets the keyboard focus, before rxvt-unicode
310	does focus in processing.	538	does focus in processing.
…		…
312	=item on_focus_out $term	540	=item on_focus_out $term
313		541
314	Called wheneever the window loses keyboard focus, before rxvt-unicode does	542	Called wheneever the window loses keyboard focus, before rxvt-unicode does
315	focus out processing.	543	focus out processing.
316		544
		545	=item on_configure_notify $term, $event
		546
		547	=item on_property_notify $term, $event
		548
317	=item on_key_press $term, $event, $keysym, $octets	549	=item on_key_press $term, $event, $keysym, $octets
318		550
319	=item on_key_release $term, $event, $keysym	551	=item on_key_release $term, $event, $keysym
320		552
321	=item on_button_press $term, $event	553	=item on_button_press $term, $event
…		…
330		562
331	Called whenever the corresponding X event is received for the terminal If	563	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.	564	the hook returns true, then the even will be ignored by rxvt-unicode.
333		565
334	The event is a hash with most values as named by Xlib (see the XEvent	566	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	567	manpage), with the additional members C<row> and C<col>, which are the
336	and column under the mouse cursor.	568	(real, not screen-based) row and column under the mouse cursor.
337		569
338	C<on_key_press> additionally receives the string rxvt-unicode would	570	C<on_key_press> additionally receives the string rxvt-unicode would
339	output, if any, in locale-specific encoding.	571	output, if any, in locale-specific encoding.
340		572
341	subwindow.	573	subwindow.
342		574
343	=back	575	=item on_client_message $term, $event
344		576
345	=head2 Variables in the C<urxvt> Package	577	=item on_wm_protocols $term, $event
346		578
347	=over 4	579	=item on_wm_delete_window $term, $event
348		580
349	=item $urxvt::TERM	581	Called when various types of ClientMessage events are received (all with
350		582	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		583
453	=back	584	=back
454		585
455	=cut	586	=cut
456		587
…		…
462	use Scalar::Util ();	593	use Scalar::Util ();
463	use List::Util ();	594	use List::Util ();
464		595
465	our $VERSION = 1;	596	our $VERSION = 1;
466	our $TERM;	597	our $TERM;
		598	our @TERM_INIT;
		599	our @TERM_EXT;
467	our @HOOKNAME;	600	our @HOOKNAME;
468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	601	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
469	our %OPTION;	602	our %OPTION;
470		603
471	our $LIBDIR;	604	our $LIBDIR;
472	our $RESNAME;	605	our $RESNAME;
473	our $RESCLASS;	606	our $RESCLASS;
474	our $RXVTNAME;	607	our $RXVTNAME;
475		608
		609	our $NOCHAR = chr 0xffff;
		610
		611	=head2 Variables in the C<urxvt> Package
		612
		613	=over 4
		614
		615	=item $urxvt::LIBDIR
		616
		617	The rxvt-unicode library directory, where, among other things, the perl
		618	modules and scripts are stored.
		619
		620	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		621
		622	The resource class and name rxvt-unicode uses to look up X resources.
		623
		624	=item $urxvt::RXVTNAME
		625
		626	The basename of the installed binaries, usually C<urxvt>.
		627
		628	=item $urxvt::TERM
		629
		630	The current terminal. This variable stores the current C<urxvt::term>
		631	object, whenever a callback/hook is executing.
		632
		633	=item @urxvt::TERM_INIT
		634
		635	All coderefs in this array will be called as methods of the next newly
		636	created C<urxvt::term> object (during the C<on_init> phase). The array
		637	gets cleared before the codereferences that were in it are being executed,
		638	so coderefs can push themselves onto it again if they so desire.
		639
		640	This complements to the perl-eval commandline option, but gets executed
		641	first.
		642
		643	=item @urxvt::TERM_EXT
		644
		645	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		646	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		647	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		648
		649	=back
		650
		651	=head2 Functions in the C<urxvt> Package
		652
		653	=over 4
		654
		655	=item urxvt::fatal $errormessage
		656
		657	Fatally aborts execution with the given error message. Avoid at all
		658	costs! The only time this is acceptable is when the terminal process
		659	starts up.
		660
		661	=item urxvt::warn $string
		662
		663	Calls C<rxvt_warn> with the given string which should not include a
		664	newline. The module also overwrites the C<warn> builtin with a function
		665	that calls this function.
		666
		667	Using this function has the advantage that its output ends up in the
		668	correct place, e.g. on stderr of the connecting urxvtc client.
		669
		670	Messages have a size limit of 1023 bytes currently.
		671
		672	=item $time = urxvt::NOW
		673
		674	Returns the "current time" (as per the event loop).
		675
		676	=item urxvt::CurrentTime
		677
		678	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		679	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		680	Button4Mask, Button5Mask, AnyModifier
		681
		682	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		683	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		684	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		685	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		686	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		687	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		688	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		689
		690	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		691	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		692	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		693	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		694	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		695	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		696	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		697
		698	Various constants for use in X calls and event processing.
		699
		700	=back
		701
		702	=head2 RENDITION
		703
		704	Rendition bitsets contain information about colour, font, font styles and
		705	similar information for each screen cell.
		706
		707	The following "macros" deal with changes in rendition sets. You should
		708	never just create a bitset, you should always modify an existing one,
		709	as they contain important information required for correct operation of
		710	rxvt-unicode.
		711
		712	=over 4
		713
		714	=item $rend = urxvt::DEFAULT_RSTYLE
		715
		716	Returns the default rendition, as used when the terminal is starting up or
		717	being reset. Useful as a base to start when creating renditions.
		718
		719	=item $rend = urxvt::OVERLAY_RSTYLE
		720
		721	Return the rendition mask used for overlays by default.
		722
		723	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		724
		725	Return the bit that enabled bold, italic, blink, reverse-video and
		726	underline, respectively. To enable such a style, just logically OR it into
		727	the bitset.
		728
		729	=item $foreground = urxvt::GET_BASEFG $rend
		730
		731	=item $background = urxvt::GET_BASEBG $rend
		732
		733	Return the foreground/background colour index, respectively.
		734
		735	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		736
		737	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		738
		739	Replace the foreground/background colour in the rendition mask with the
		740	specified one.
		741
		742	=item $value = urxvt::GET_CUSTOM $rend
		743
		744	Return the "custom" value: Every rendition has 5 bits for use by
		745	extensions. They can be set and changed as you like and are initially
		746	zero.
		747
		748	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		749
		750	Change the custom value.
		751
		752	=back
		753
		754	=cut
		755
476	BEGIN {	756	BEGIN {
477	urxvt->bootstrap;
478
479	# overwrite perl's warn	757	# overwrite perl's warn
480	*CORE::GLOBAL::warn = sub {	758	*CORE::GLOBAL::warn = sub {
481	my $msg = join "", @_;	759	my $msg = join "", @_;
482	$msg .= "\n"	760	$msg .= "\n"
483	unless $msg =~ /\n$/;	761	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	762	urxvt::warn ($msg);
485	};	763	};
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	}	764	}
492		765
493	my @hook_count;	766	no warnings 'utf8';
		767
494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	768	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495		769
496	sub verbose {	770	sub verbose {
497	my ($level, $msg) = @_;	771	my ($level, $msg) = @_;
498	warn "$msg\n" if $level <= $verbosity;	772	warn "$msg\n" if $level <= $verbosity;
499	}	773	}
500		774
501	my $extension_pkg = "extension0000";
502	my %extension_pkg;	775	my %extension_pkg;
503		776
504	# load a single script into its own package, once only	777	# load a single script into its own package, once only
505	sub extension_package($) {	778	sub extension_package($) {
506	my ($path) = @_;	779	my ($path) = @_;
507		780
508	$extension_pkg{$path} ||= do {	781	$extension_pkg{$path} ||= do {
509	my $pkg = "urxvt::" . ($extension_pkg++);	782	$path =~ /([^\/\\]+)$/;
		783	my $pkg = $1;
		784	$pkg =~ s/[^[:word:]]/_/g;
		785	$pkg = "urxvt::ext::$pkg";
510		786
511	verbose 3, "loading extension '$path' into package '$pkg'";	787	verbose 3, "loading extension '$path' into package '$pkg'";
512		788
513	open my $fh, "<:raw", $path	789	open my $fh, "<:raw", $path
514	or die "$path: $!";	790	or die "$path: $!";
515		791
516	my $source = untaint	792	my $source =
517	"package $pkg; use strict; use utf8;\n"	793	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
518	. "use base urxvt::term::extension::;\n"
519	. "#line 1 \"$path\"\n{\n"	794	. "#line 1 \"$path\"\n{\n"
520	. (do { local $/; <$fh> })	795	. (do { local $/; <$fh> })
521	. "\n};\n1";	796	. "\n};\n1";
522		797
523	eval $source	798	eval $source
…		…
537	if ($htype == 0) { # INIT	812	if ($htype == 0) { # INIT
538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	813	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
539		814
540	my %ext_arg;	815	my %ext_arg;
541		816
		817	{
		818	my @init = @TERM_INIT;
		819	@TERM_INIT = ();
		820	$_->($TERM) for @init;
		821	my @pkg = @TERM_EXT;
		822	@TERM_EXT = ();
		823	$TERM->register_package ($_) for @pkg;
		824	}
		825
542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	826	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
543	if ($_ eq "default") {	827	if ($_ eq "default") {
544	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	828	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
545	} elsif (/^-(.*)$/) {	829	} elsif (/^-(.*)$/) {
546	delete $ext_arg{$1};	830	delete $ext_arg{$1};
547	} elsif (/^([^<]+)<(.*)>$/) {	831	} elsif (/^([^<]+)<(.*)>$/) {
548	push @{ $ext_arg{$1} }, $2;	832	push @{ $ext_arg{$1} }, $2;
549	} else {	833	} else {
…		…
572	if $verbosity >= 10;	856	if $verbosity >= 10;
573		857
574	keys %$cb;	858	keys %$cb;
575		859
576	while (my ($pkg, $cb) = each %$cb) {	860	while (my ($pkg, $cb) = each %$cb) {
577	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	861	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
578	and last;	862	$retval ||= $retval_;
579		863
580	if ($@) {	864	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	865	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	866	warn $@;
583	}	867	}
584	}	868	}
		869
		870	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		871	if $verbosity >= 11;
585	}	872	}
586		873
587	if ($htype == 1) { # DESTROY	874	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	875	# clear package objects
596	%$_ = () for values %{ $TERM->{_pkg} };	876	%$_ = () for values %{ $TERM->{_pkg} };
597		877
598	# clear package	878	# clear package
599	%$TERM = ();	879	%$TERM = ();
…		…
613	while (my ($name, $cb) = each %hook) {	893	while (my ($name, $cb) = each %hook) {
614	my $htype = $HOOKTYPE{uc $name};	894	my $htype = $HOOKTYPE{uc $name};
615	defined $htype	895	defined $htype
616	or Carp::croak "unsupported hook type '$name'";	896	or Carp::croak "unsupported hook type '$name'";
617		897
		898	$self->set_should_invoke ($htype, +1)
618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	899	unless exists $self->{term}{_hook}[$htype]{$pkg};
619	$hook_count[$htype]++
620	or urxvt::set_should_invoke $htype, 1;
621	}
622		900
623	$self->{term}{_hook}[$htype]{$pkg} = $cb;	901	$self->{term}{_hook}[$htype]{$pkg} = $cb;
624	}	902	}
625	}	903	}
626		904
…		…
631	for my $name (@hook) {	909	for my $name (@hook) {
632	my $htype = $HOOKTYPE{uc $name};	910	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	911	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	912	or Carp::croak "unsupported hook type '$name'";
635		913
		914	$self->set_should_invoke ($htype, -1)
636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	915	if delete $self->{term}{_hook}[$htype]{$pkg};
637	--$hook_count[$htype]
638	or urxvt::set_should_invoke $htype, 0;
639	}
640	}	916	}
641	}	917	}
642		918
643	our $AUTOLOAD;	919	our $AUTOLOAD;
644		920
…		…
675		951
676	=head2 The C<urxvt::anyevent> Class	952	=head2 The C<urxvt::anyevent> Class
677		953
678	The sole purpose of this class is to deliver an interface to the	954	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	955	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	956	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	957	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	958	is that you cannot use blocking APIs, but the non-blocking variant should
		959	work.
683		960
684	=cut	961	=cut
685		962
686	our $VERSION = 1;	963	our $VERSION = 1;
687		964
…		…
749	# find on_xxx subs in the package and register them	1026	# find on_xxx subs in the package and register them
750	# as hooks	1027	# as hooks
751	sub register_package {	1028	sub register_package {
752	my ($self, $pkg, $argv) = @_;	1029	my ($self, $pkg, $argv) = @_;
753		1030
		1031	no strict 'refs';
		1032
		1033	urxvt::verbose 6, "register package $pkg to $self";
		1034
		1035	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1036
754	my $proxy = bless {	1037	my $proxy = bless {
755	_pkg => $pkg,	1038	_pkg => $pkg,
756	argv => $argv,	1039	argv => $argv,
757	}, $pkg;	1040	}, $pkg;
758	Scalar::Util::weaken ($proxy->{term} = $self);	1041	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
764	$proxy->enable ($name => $ref);	1047	$proxy->enable ($name => $ref);
765	}	1048	}
766	}	1049	}
767	}	1050	}
768		1051
		1052	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1053
		1054	Creates a new terminal, very similar as if you had started it with system
		1055	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1056	hash which defines the environment of the new terminal.
		1057
		1058	Croaks (and probably outputs an error message) if the new instance
		1059	couldn't be created. Returns C<undef> if the new instance didn't
		1060	initialise perl, and the terminal object otherwise. The C<init> and
		1061	C<start> hooks will be called during this call.
		1062
		1063	=cut
		1064
		1065	sub new {
		1066	my ($class, $env, @args) = @_;
		1067
		1068	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		1069	}
		1070
769	=item $term->destroy	1071	=item $term->destroy
770		1072
771	Destroy the terminal object (close the window, free resources etc.).	1073	Destroy the terminal object (close the window, free resources
		1074	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1075	watchers (timers, io watchers) are still active.
		1076
		1077	=item $term->exec_async ($cmd[, @args])
		1078
		1079	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1080	("starts") programs in the background. This function takes care of setting
		1081	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1082	be preferred over explicit calls to C<exec> or C<system>.
		1083
		1084	Returns the pid of the subprocess or C<undef> on error.
		1085
		1086	=cut
		1087
		1088	sub exec_async {
		1089	my $self = shift;
		1090
		1091	my $pid = fork;
		1092
		1093	return $pid
		1094	if !defined $pid or $pid;
		1095
		1096	%ENV = %{ $self->env };
		1097
		1098	exec @_;
		1099	urxvt::_exit 255;
		1100	}
772		1101
773	=item $isset = $term->option ($optval[, $set])	1102	=item $isset = $term->option ($optval[, $set])
774		1103
775	Returns true if the option specified by C<$optval> is enabled, and	1104	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	1105	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	1108	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:	1109	source file F</src/optinc.h> to see the actual list:
781		1110
782	borderLess console cursorBlink cursorUnderline hold iconic insecure	1111	borderLess console cursorBlink cursorUnderline hold iconic insecure
783	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1112	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
784	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1113	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
785	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1114	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
786	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1115	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
787	tripleclickwords utmpInhibit visualBell	1116	transparent tripleclickwords utmpInhibit visualBell
788		1117
789	=item $value = $term->resource ($name[, $newval])	1118	=item $value = $term->resource ($name[, $newval])
790		1119
791	Returns the current resource value associated with a given name and	1120	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>	1121	optionally sets a new value. Setting values is most useful in the C<init>
…		…
809		1138
810	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1139	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
811	borderLess color cursorBlink cursorUnderline cutchars delete_key	1140	borderLess color cursorBlink cursorUnderline cutchars delete_key
812	display_name embed ext_bwidth fade font geometry hold iconName	1141	display_name embed ext_bwidth fade font geometry hold iconName
813	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1142	imFont imLocale inputMethod insecure int_bwidth intensityStyles
814	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1143	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
815	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1144	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
816	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1145	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
817	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1146	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
818	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1147	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
819	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1148	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
820	shade term_name title transparent transparent_all tripleclickwords	1149	secondaryScreen secondaryScroll selectstyle shade term_name title
821	utmpInhibit visualBell	1150	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1151	visualBell
822		1152
823	=cut	1153	=cut
824		1154
825	sub resource($$;$) {	1155	sub resource($$;$) {
826	my ($self, $name) = (shift, shift);	1156	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1157	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	1158	&urxvt::term::_resource
829	}	1159	}
830		1160
		1161	=item $value = $term->x_resource ($pattern)
		1162
		1163	Returns the X-Resource for the given pattern, excluding the program or
		1164	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1165	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1166	resource with that pattern exists.
		1167
		1168	This method should only be called during the C<on_start> hook, as there is
		1169	only one resource database per display, and later invocations might return
		1170	the wrong resources.
		1171
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1172	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		1173
833	Adds a keymap translation exactly as specified via a resource. See the	1174	Adds a keymap translation exactly as specified via a resource. See the
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1175	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835		1176
…		…
850	=item ($row, $col) = $term->selection_end ([$row, $col])	1191	=item ($row, $col) = $term->selection_end ([$row, $col])
851		1192
852	Return the current values of the selection mark, begin or end positions,	1193	Return the current values of the selection mark, begin or end positions,
853	and optionally set them to new values.	1194	and optionally set them to new values.
854		1195
		1196	=item $term->selection_make ($eventtime[, $rectangular])
		1197
		1198	Tries to make a selection as set by C<selection_beg> and
		1199	C<selection_end>. If C<$rectangular> is true (default: false), a
		1200	rectangular selection will be made. This is the prefered function to make
		1201	a selection.
		1202
855	=item $success = $term->selection_grab ($eventtime)	1203	=item $success = $term->selection_grab ($eventtime)
856		1204
857	Try to request the primary selection from the server (for example, as set	1205	Try to request the primary selection text from the server (for example, as
858	by the next method).	1206	set by the next method). No visual feedback will be given. This function
		1207	is mostly useful from within C<on_sel_grab> hooks.
859		1208
860	=item $oldtext = $term->selection ([$newtext])	1209	=item $oldtext = $term->selection ([$newtext])
861		1210
862	Return the current selection text and optionally replace it by C<$newtext>.	1211	Return the current selection text and optionally replace it by C<$newtext>.
863		1212
…		…
956	Convert the given locale-encoded octets into a perl string.	1305	Convert the given locale-encoded octets into a perl string.
957		1306
958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1307	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959		1308
960	XORs the rendition values in the given span with the provided value	1309	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	1310	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962	to the selection.	1311	refresh hooks to provide effects similar to the selection.
963		1312
964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1313	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965		1314
966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1315	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1316	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	1317	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
969	it instead.	1318	it instead. Both styles I<MUST NOT> contain font styles.
970		1319
971	=item $term->scr_bell	1320	=item $term->scr_bell
972		1321
973	Ring the bell!	1322	Ring the bell!
974		1323
…		…
981		1330
982	Normally its not a good idea to use this function, as programs might be	1331	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	1332	confused by changes in cursor position or scrolling. Its useful inside a
984	C<on_add_lines> hook, though.	1333	C<on_add_lines> hook, though.
985		1334
		1335	=item $term->scr_change_screen ($screen)
		1336
		1337	Switch to given screen - 0 primary, 1 secondary.
		1338
986	=item $term->cmd_parse ($octets)	1339	=item $term->cmd_parse ($octets)
987		1340
988	Similar to C<scr_add_lines>, but the argument must be in the	1341	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	1342	locale-specific encoding of the terminal and can contain command sequences
990	(escape codes) that will be interpreted.	1343	(escape codes) that will be interpreted.
…		…
1000	Replaces the event mask of the pty watcher by the given event mask. Can	1353	Replaces the event mask of the pty watcher by the given event mask. Can
1001	be used to suppress input and output handling to the pty/tty. See the	1354	be used to suppress input and output handling to the pty/tty. See the
1002	description of C<< urxvt::timer->events >>. Make sure to always restore	1355	description of C<< urxvt::timer->events >>. Make sure to always restore
1003	the previous value.	1356	the previous value.
1004		1357
		1358	=item $fd = $term->pty_fd
		1359
		1360	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1361	is used.
		1362
1005	=item $windowid = $term->parent	1363	=item $windowid = $term->parent
1006		1364
1007	Return the window id of the toplevel window.	1365	Return the window id of the toplevel window.
1008		1366
1009	=item $windowid = $term->vt	1367	=item $windowid = $term->vt
1010		1368
1011	Return the window id of the terminal window.	1369	Return the window id of the terminal window.
1012		1370
		1371	=item $term->vt_emask_add ($x_event_mask)
		1372
		1373	Adds the specified events to the vt event mask. Useful e.g. when you want
		1374	to receive pointer events all the times:
		1375
		1376	$term->vt_emask_add (urxvt::PointerMotionMask);
		1377
1013	=item $window_width = $term->width	1378	=item $window_width = $term->width
1014		1379
1015	=item $window_height = $term->height	1380	=item $window_height = $term->height
1016		1381
1017	=item $font_width = $term->fwidth	1382	=item $font_width = $term->fwidth
…		…
1030		1395
1031	=item $max_scrollback = $term->saveLines	1396	=item $max_scrollback = $term->saveLines
1032		1397
1033	=item $nrow_plus_saveLines = $term->total_rows	1398	=item $nrow_plus_saveLines = $term->total_rows
1034		1399
1035	=item $lines_in_scrollback = $term->nsaved	1400	=item $topmost_scrollback_row = $term->top_row
1036		1401
1037	Return various integers describing terminal characteristics.	1402	Return various integers describing terminal characteristics.
1038		1403
		1404	=item $x_display = $term->display_id
		1405
		1406	Return the DISPLAY used by rxvt-unicode.
		1407
1039	=item $lc_ctype = $term->locale	1408	=item $lc_ctype = $term->locale
1040		1409
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1410	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1411
1043	=item $x_display = $term->display_id	1412	=item $env = $term->env
1044		1413
1045	Return the DISPLAY used by rxvt-unicode.	1414	Returns a copy of the environment in effect for the terminal as a hashref
		1415	similar to C<\%ENV>.
		1416
		1417	=cut
		1418
		1419	sub env {
		1420	if (my $env = $_[0]->_env) {
		1421	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1422	} else {
		1423	+{ %ENV }
		1424	}
		1425	}
1046		1426
1047	=item $modifiermask = $term->ModLevel3Mask	1427	=item $modifiermask = $term->ModLevel3Mask
1048		1428
1049	=item $modifiermask = $term->ModMetaMask	1429	=item $modifiermask = $term->ModMetaMask
1050		1430
1051	=item $modifiermask = $term->ModNumLockMask	1431	=item $modifiermask = $term->ModNumLockMask
1052		1432
1053	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1433	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.	1434	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1055		1435
		1436	=item $screen = $term->current_screen
		1437
		1438	Returns the currently displayed screen (0 primary, 1 secondary).
		1439
		1440	=item $cursor_is_hidden = $term->hidden_cursor
		1441
		1442	Returns wether the cursor is currently hidden or not.
		1443
1056	=item $view_start = $term->view_start ([$newvalue])	1444	=item $view_start = $term->view_start ([$newvalue])
1057		1445
1058	Returns the negative row number of the topmost line. Minimum value is	1446	Returns the row number of the topmost displayed line. Maximum value is
1059	C<0>, which displays the normal terminal contents. Larger values scroll	1447	C<0>, which displays the normal terminal contents. Lower values scroll
1060	this many lines into the scrollback buffer.	1448	this many lines into the scrollback buffer.
1061		1449
1062	=item $term->want_refresh	1450	=item $term->want_refresh
1063		1451
1064	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1452	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1079	line, starting at column C<$start_col> (default C<0>), which is useful	1467	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	1468	to replace only parts of a line. The font index in the rendition will
1081	automatically be updated.	1469	automatically be updated.
1082		1470
1083	C<$text> is in a special encoding: tabs and wide characters that use more	1471	C<$text> is in a special encoding: tabs and wide characters that use more
1084	than one cell when displayed are padded with urxvt::NOCHAR characters	1472	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1085	(C<chr 65535>). Characters with combining characters and other characters	1473	characters. Characters with combining characters and other characters that
1086	that do not fit into the normal tetx encoding will be replaced with	1474	do not fit into the normal tetx encoding will be replaced with characters
1087	characters in the private use area.	1475	in the private use area.
1088		1476
1089	You have to obey this encoding when changing text. The advantage is	1477	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	1478	that C<substr> and similar functions work on screen cells and not on
1091	characters.	1479	characters.
1092		1480
…		…
1143	Return the row number of the first/last row of the line, respectively.	1531	Return the row number of the first/last row of the line, respectively.
1144		1532
1145	=item $offset = $line->offset_of ($row, $col)	1533	=item $offset = $line->offset_of ($row, $col)
1146		1534
1147	Returns the character offset of the given row|col pair within the logical	1535	Returns the character offset of the given row|col pair within the logical
1148	line.	1536	line. Works for rows outside the line, too, and returns corresponding
		1537	offsets outside the string.
1149		1538
1150	=item ($row, $col) = $line->coord_of ($offset)	1539	=item ($row, $col) = $line->coord_of ($offset)
1151		1540
1152	Translates a string offset into terminal coordinates again.	1541	Translates a string offset into terminal coordinates again.
1153		1542
…		…
1266		1655
1267	Calls XUngrab for the most recent grab. Is called automatically on	1656	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	1657	evaluation errors, as it is better to lose the grab in the error case as
1269	the session.	1658	the session.
1270		1659
		1660	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1661
		1662	=item $atom_name = $term->XGetAtomName ($atom)
		1663
		1664	=item @atoms = $term->XListProperties ($window)
		1665
		1666	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1667
		1668	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1669
		1670	=item $term->XDeleteProperty ($window, $property)
		1671
		1672	=item $window = $term->DefaultRootWindow
		1673
		1674	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1675
		1676	=item $term->XMapWindow ($window)
		1677
		1678	=item $term->XUnmapWindow ($window)
		1679
		1680	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1681
		1682	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1683
		1684	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1685
		1686	Various X or X-related functions. The C<$term> object only serves as
		1687	the source of the display, otherwise those functions map more-or-less
		1688	directory onto the X functions of the same name.
		1689
1271	=back	1690	=back
1272		1691
1273	=cut	1692	=cut
1274		1693
1275	package urxvt::popup;	1694	package urxvt::popup;
…		…
1289		1708
1290	$item->{render} ||= sub { $_[0]{text} };	1709	$item->{render} ||= sub { $_[0]{text} };
1291		1710
1292	push @{ $self->{item} }, $item;	1711	push @{ $self->{item} }, $item;
1293	}	1712	}
		1713
		1714	=item $popup->add_title ($title)
		1715
		1716	Adds a non-clickable title to the popup.
		1717
		1718	=cut
		1719
		1720	sub add_title {
		1721	my ($self, $title) = @_;
		1722
		1723	$self->add_item ({
		1724	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1725	text => $title,
		1726	activate => sub { },
		1727	});
		1728	}
		1729
		1730	=item $popup->add_separator ([$sepchr])
		1731
		1732	Creates a separator, optionally using the character given as C<$sepchr>.
		1733
		1734	=cut
1294		1735
1295	sub add_separator {	1736	sub add_separator {
1296	my ($self, $sep) = @_;	1737	my ($self, $sep) = @_;
1297		1738
1298	$sep ||= "=";	1739	$sep ||= "=";
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1744	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1745	activate => sub { },
1305	});	1746	});
1306	}	1747	}
1307		1748
1308	sub add_title {	1749	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1750
1311	$self->add_item ({	1751	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" },	1752	selected.
1313	text => $title,	1753
1314	activate => sub { },	1754	=cut
1315	});
1316	}
1317		1755
1318	sub add_button {	1756	sub add_button {
1319	my ($self, $text, $cb) = @_;	1757	my ($self, $text, $cb) = @_;
1320		1758
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1759	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	1760	}
		1761
		1762	=item $popup->add_toggle ($text, $cb, $initial_value)
		1763
		1764	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1765	whenever it gets toggled, with a boolean indicating its value as its first
		1766	argument.
		1767
		1768	=cut
1323		1769
1324	sub add_toggle {	1770	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1771	my ($self, $text, $cb, $value) = @_;
1326		1772
1327	my $item; $item = {	1773	my $item; $item = {
1328	type => "button",	1774	type => "button",
1329	text => " $text",	1775	text => " $text",
1330	value => $value,	1776	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1777	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1778	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1779	};
1334		1780
1335	$self->add_item ($item);	1781	$self->add_item ($item);
1336	}	1782	}
		1783
		1784	=item $popup->show
		1785
		1786	Displays the popup (which is initially hidden).
		1787
		1788	=cut
1337		1789
1338	sub show {	1790	sub show {
1339	my ($self) = @_;	1791	my ($self) = @_;
1340		1792
1341	local $urxvt::popup::self = $self;	1793	local $urxvt::popup::self = $self;
1342		1794
		1795	my $env = $self->{term}->env;
		1796	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1797	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1798	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1799
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1800	urxvt::term->new ($env, "popup",
		1801	"--perl-lib" => "", "--perl-ext-common" => "",
		1802	"-pty-fd" => -1, "-sl" => 0,
		1803	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1346	"--transient-for" => $self->{term}->parent,	1804	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1805	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1806	"-pe" => "urxvt-popup")
1349	or die "unable to create popup window\n";	1807	or die "unable to create popup window\n";
1350	}	1808	}
1351		1809
1352	sub DESTROY {	1810	sub DESTROY {
1353	my ($self) = @_;	1811	my ($self) = @_;
1354		1812
1355	delete $self->{term}{_destroy}{$self};	1813	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1814	$self->{term}->ungrab;
1357	}	1815	}
		1816
		1817	=back
		1818
		1819	=cut
		1820
		1821	package urxvt::watcher;
		1822
		1823	@urxvt::timer::ISA = __PACKAGE__;
		1824	@urxvt::iow::ISA = __PACKAGE__;
		1825	@urxvt::pw::ISA = __PACKAGE__;
		1826	@urxvt::iw::ISA = __PACKAGE__;
1358		1827
1359	=head2 The C<urxvt::timer> Class	1828	=head2 The C<urxvt::timer> Class
1360		1829
1361	This class implements timer watchers/events. Time is represented as a	1830	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1831	fractional number of seconds since the epoch. Example:
…		…
1400	Start the timer.	1869	Start the timer.
1401		1870
1402	=item $timer = $timer->start ($tstamp)	1871	=item $timer = $timer->start ($tstamp)
1403		1872
1404	Set the event trigger time to C<$tstamp> and start the timer.	1873	Set the event trigger time to C<$tstamp> and start the timer.
		1874
		1875	=item $timer = $timer->after ($delay)
		1876
		1877	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1405		1878
1406	=item $timer = $timer->stop	1879	=item $timer = $timer->stop
1407		1880
1408	Stop the timer.	1881	Stop the timer.
1409		1882
…		…
1456		1929
1457	Stop watching for events on the given filehandle.	1930	Stop watching for events on the given filehandle.
1458		1931
1459	=back	1932	=back
1460		1933
		1934	=head2 The C<urxvt::iw> Class
		1935
		1936	This class implements idle watchers, that get called automatically when
		1937	the process is idle. They should return as fast as possible, after doing
		1938	some useful work.
		1939
		1940	=over 4
		1941
		1942	=item $iw = new urxvt::iw
		1943
		1944	Create a new idle watcher object in stopped state.
		1945
		1946	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1947
		1948	Set the callback to be called when the watcher triggers.
		1949
		1950	=item $timer = $timer->start
		1951
		1952	Start the watcher.
		1953
		1954	=item $timer = $timer->stop
		1955
		1956	Stop the watcher.
		1957
		1958	=back
		1959
		1960	=head2 The C<urxvt::pw> Class
		1961
		1962	This class implements process watchers. They create an event whenever a
		1963	process exits, after which they stop automatically.
		1964
		1965	my $pid = fork;
		1966	...
		1967	$term->{pw} = urxvt::pw
		1968	->new
		1969	->start ($pid)
		1970	->cb (sub {
		1971	my ($pw, $exit_status) = @_;
		1972	...
		1973	});
		1974
		1975	=over 4
		1976
		1977	=item $pw = new urxvt::pw
		1978
		1979	Create a new process watcher in stopped state.
		1980
		1981	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1982
		1983	Set the callback to be called when the timer triggers.
		1984
		1985	=item $pw = $timer->start ($pid)
		1986
		1987	Tells the wqtcher to start watching for process C<$pid>.
		1988
		1989	=item $pw = $pw->stop
		1990
		1991	Stop the watcher.
		1992
		1993	=back
		1994
1461	=head1 ENVIRONMENT	1995	=head1 ENVIRONMENT
1462		1996
1463	=head2 URXVT_PERL_VERBOSITY	1997	=head2 URXVT_PERL_VERBOSITY
1464		1998
1465	This variable controls the verbosity level of the perl extension. Higher	1999	This variable controls the verbosity level of the perl extension. Higher
…		…
1469		2003
1470	=item == 0 - fatal messages	2004	=item == 0 - fatal messages
1471		2005
1472	=item >= 3 - script loading and management	2006	=item >= 3 - script loading and management
1473		2007
1474	=item >=10 - all events received	2008	=item >=10 - all called hooks
		2009
		2010	=item >=11 - hook reutrn values
1475		2011
1476	=back	2012	=back
1477		2013
1478	=head1 AUTHOR	2014	=head1 AUTHOR
1479		2015

Diff Legend

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