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.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC

…		…
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	(More) intelligent selection. This extension tries to be more intelligent	48	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	49	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	50	now, it tries to select words, urls and complete shell-quoted
47	too, 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
		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
49	It also offers the following bindable keyboard command:	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
…		…
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 (such as uri unescaping, perl	102	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.	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	};
71		123
72	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
73		125
74	Adds regex search functionality to the scrollback buffer, triggered	126	Adds regex search functionality to the scrollback buffer, triggered
75	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
76	input/output is suspended.	128	input/output is suspended and a regex is displayed at the bottom of the
		129	screen.
77		130
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	131	Inputting characters appends them to the regex and continues incremental
79	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>
80	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
81	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.
82		138
83	=item digital-clock	139	=item readline (enabled by default)
84		140
85	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.
		209
		210	The tabbar itself can be configured similarly to a normal terminal, but
		211	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		212	following four resources (shown with defaults):
		213
		214	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		215	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		216	URxvt.tabbed.tab-fg: <colour-index, default 0>
		217	URxvt.tabbed.tab-bg: <colour-index, default 1>
		218
		219	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		220	indices.
86		221
87	=item mark-urls	222	=item mark-urls
88		223
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	224	Uses per-line display filtering (C<on_line_update>) to underline urls and
		225	make them clickable. When middle-clicked, the program specified in the
		226	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		227	the URL as first argument.
		228
		229	=item xim-onthespot
		230
		231	This (experimental) perl extension implements OnTheSpot editing. It does
		232	not work perfectly, and some input methods don't seem to work well with
		233	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		234	kinput2.
		235
		236	You enable it by specifying this extension and a preedit style of
		237	C<OnTheSpot>, i.e.:
		238
		239	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		240
		241	=item automove-background
		242
		243	This is basically a one-line extension that dynamically changes the background pixmap offset
		244	to the window position, in effect creating the same effect as pseudo transparency with
		245	a custom pixmap. No scaling is supported in this mode. Exmaple:
		246
		247	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90		248
91	=item block-graphics-to-ascii	249	=item block-graphics-to-ascii
92		250
93	A not very useful example of filtering all text output to the terminal,	251	A not very useful example of filtering all text output to the terminal,
94	by replacing all line-drawing characters (U+2500 .. U+259F) by a	252	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	253	similar-looking ascii character.
		254
		255	=item digital-clock
		256
		257	Displays a digital clock using the built-in overlay.
		258
		259	=item remote-clipboard
		260
		261	Somewhat of a misnomer, this extension adds two menu entries to the
		262	selection popup that allows one ti run external commands to store the
		263	selection somewhere and fetch it again.
		264
		265	We use it to implement a "distributed selection mechanism", which just
		266	means that one command uploads the file to a remote server, and another
		267	reads it.
		268
		269	The commands can be set using the C<URxvt.remote-selection.store> and
		270	C<URxvt.remote-selection.fetch> resources. The first should read the
		271	selection to store from STDIN (always in UTF-8), the second should provide
		272	the selection data on STDOUT (also in UTF-8).
		273
		274	The defaults (which are likely useless to you) use rsh and cat:
		275
		276	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		277	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		278
		279	=item selection-pastebin
		280
		281	This is a little rarely useful extension that Uploads the selection as
		282	textfile to a remote site (or does other things). (The implementation is
		283	not currently secure for use in a multiuser environment as it writes to
		284	F</tmp> directly.).
		285
		286	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		287	i.e.
		288
		289	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		290
		291	Pressing this combination runs a command with C<%> replaced by the name of
		292	the textfile. This command can be set via a resource:
		293
		294	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		295
		296	And the default is likely not useful to anybody but the few people around
		297	here :)
		298
		299	The name of the textfile is the hex encoded md5 sum of the selection, so
		300	the same content should lead to the same filename.
		301
		302	After a successful upload the selection will be replaced by the text given
		303	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		304	for the filename):
		305
		306	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
96		307
97	=item example-refresh-hooks	308	=item example-refresh-hooks
98		309
99	Displays a very simple digital clock in the upper right corner of the	310	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	311	window. Illustrates overwriting the refresh callbacks to create your own
…		…
123	=over 4	334	=over 4
124		335
125	=item $text	336	=item $text
126		337
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	338	Rxvt-unicodes special way of encoding text, where one "unicode" character
128	always represents one screen cell. See L<row_t> for a discussion of this format.	339	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		340
130	=item $string	341	=item $string
131		342
132	A perl text string, with an emphasis on I<text>. It can store all unicode	343	A perl text string, with an emphasis on I<text>. It can store all unicode
133	characters and is to be distinguished with text encoded in a specific	344	characters and is to be distinguished with text encoded in a specific
…		…
179	called whenever the relevant event happens.	390	called whenever the relevant event happens.
180		391
181	The first argument passed to them is an extension oject as described in	392	The first argument passed to them is an extension oject as described in
182	the in the C<Extension Objects> section.	393	the in the C<Extension Objects> section.
183		394
184	B<All> of these hooks must return a boolean value. If it is true, then the	395	B<All> of these hooks must return a boolean value. If any of the called
185	event counts as being I<consumed>, and the invocation of other hooks is	396	hooks returns true, then the event counts as being I<consumed>, and the
186	skipped, and the relevant action might not be carried out by the C++ code.	397	relevant action might not be carried out by the C++ code.
187		398
188	I<< When in doubt, return a false value (preferably C<()>). >>	399	I<< When in doubt, return a false value (preferably C<()>). >>
189		400
190	=over 4	401	=over 4
191		402
192	=item on_init $term	403	=item on_init $term
193		404
194	Called after a new terminal object has been initialized, but before	405	Called after a new terminal object has been initialized, but before
195	windows are created or the command gets run. Most methods are unsafe to	406	windows are created or the command gets run. Most methods are unsafe to
196	call or deliver senseless data, as terminal size and other characteristics	407	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	408	have not yet been determined. You can safely query and change resources
198	though.	409	and options, though. For many purposes the C<on_start> hook is a better
		410	place.
		411
		412	=item on_start $term
		413
		414	Called at the very end of initialisation of a new terminal, just before
		415	trying to map (display) the toplevel and returning to the mainloop.
		416
		417	=item on_destroy $term
		418
		419	Called whenever something tries to destroy terminal, when the terminal is
		420	still fully functional (not for long, though).
199		421
200	=item on_reset $term	422	=item on_reset $term
201		423
202	Called after the screen is "reset" for any reason, such as resizing or	424	Called after the screen is "reset" for any reason, such as resizing or
203	control sequences. Here is where you can react on changes to size-related	425	control sequences. Here is where you can react on changes to size-related
204	variables.	426	variables.
205		427
206	=item on_start $term	428	=item on_child_start $term, $pid
207		429
208	Called at the very end of initialisation of a new terminal, just before	430	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	431
		432	=item on_child_exit $term, $status
		433
		434	Called just after the child process has exited. C<$status> is the status
		435	from C<waitpid>.
210		436
211	=item on_sel_make $term, $eventtime	437	=item on_sel_make $term, $eventtime
212		438
213	Called whenever a selection has been made by the user, but before the	439	Called whenever a selection has been made by the user, but before the
214	selection text is copied, so changes to the beginning, end or type of the	440	selection text is copied, so changes to the beginning, end or type of the
…		…
228	=item on_sel_extend $term	454	=item on_sel_extend $term
229		455
230	Called whenever the user tries to extend the selection (e.g. with a double	456	Called whenever the user tries to extend the selection (e.g. with a double
231	click) and is either supposed to return false (normal operation), or	457	click) and is either supposed to return false (normal operation), or
232	should extend the selection itelf and return true to suppress the built-in	458	should extend the selection itelf and return true to suppress the built-in
233	processing.	459	processing. This can happen multiple times, as long as the callback
		460	returns true, it will be called on every further click by the user and is
		461	supposed to enlarge the selection more and more, if possible.
234		462
235	See the F<selection> example extension.	463	See the F<selection> example extension.
236		464
237	=item on_view_change $term, $offset	465	=item on_view_change $term, $offset
238		466
…		…
299		527
300	=item on_refresh_end $term	528	=item on_refresh_end $term
301		529
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	530	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		531
304	=item on_keyboard_command $term, $string	532	=item on_user_command $term, $string
305		533
306	Called whenever the user presses a key combination that has a	534	Called whenever the a user-configured event is being activated (e.g. via
307	C<perl:string> action bound to it (see description of the B<keysym>	535	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	536	resource in the @@RXVT_NAME@@(1) manpage).
		537
		538	The event is simply the action string. This interface is assumed to change
		539	slightly in the future.
		540
		541	=item on_x_event $term, $event
		542
		543	Called on every X event received on the vt window (and possibly other
		544	windows). Should only be used as a last resort. Most event structure
		545	members are not passed.
309		546
310	=item on_focus_in $term	547	=item on_focus_in $term
311		548
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	549	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	550	does focus in processing.
…		…
315	=item on_focus_out $term	552	=item on_focus_out $term
316		553
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	554	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	555	focus out processing.
319		556
		557	=item on_configure_notify $term, $event
		558
		559	=item on_property_notify $term, $event
		560
320	=item on_key_press $term, $event, $keysym, $octets	561	=item on_key_press $term, $event, $keysym, $octets
321		562
322	=item on_key_release $term, $event, $keysym	563	=item on_key_release $term, $event, $keysym
323		564
324	=item on_button_press $term, $event	565	=item on_button_press $term, $event
…		…
333		574
334	Called whenever the corresponding X event is received for the terminal If	575	Called whenever the corresponding X event is received for the terminal If
335	the hook returns true, then the even will be ignored by rxvt-unicode.	576	the hook returns true, then the even will be ignored by rxvt-unicode.
336		577
337	The event is a hash with most values as named by Xlib (see the XEvent	578	The event is a hash with most values as named by Xlib (see the XEvent
338	manpage), with the additional members C<row> and C<col>, which are the row	579	manpage), with the additional members C<row> and C<col>, which are the
339	and column under the mouse cursor.	580	(real, not screen-based) row and column under the mouse cursor.
340		581
341	C<on_key_press> additionally receives the string rxvt-unicode would	582	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	583	output, if any, in locale-specific encoding.
343		584
344	subwindow.	585	subwindow.
345		586
346	=back	587	=item on_client_message $term, $event
347		588
348	=head2 Variables in the C<urxvt> Package	589	=item on_wm_protocols $term, $event
349		590
350	=over 4	591	=item on_wm_delete_window $term, $event
351		592
352	=item $urxvt::LIBDIR	593	Called when various types of ClientMessage events are received (all with
353		594	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
354	The rxvt-unicode library directory, where, among other things, the perl
355	modules and scripts are stored.
356
357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
358
359	The resource class and name rxvt-unicode uses to look up X resources.
360
361	=item $urxvt::RXVTNAME
362
363	The basename of the installed binaries, usually C<urxvt>.
364
365	=item $urxvt::TERM
366
367	The current terminal. This variable stores the current C<urxvt::term>
368	object, whenever a callback/hook is executing.
369
370	=item
371
372	=back
373
374	=head2 Functions in the C<urxvt> Package
375
376	=over 4
377
378	=item $term = new urxvt [arg...]
379
380	Creates a new terminal, very similar as if you had started it with
381	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
382	if the new instance couldn't be created. Returns C<undef> if the new
383	instance didn't initialise perl, and the terminal object otherwise. The
384	C<init> and C<start> hooks will be called during the call.
385
386	=item urxvt::fatal $errormessage
387
388	Fatally aborts execution with the given error message. Avoid at all
389	costs! The only time this is acceptable is when the terminal process
390	starts up.
391
392	=item urxvt::warn $string
393
394	Calls C<rxvt_warn> with the given string which should not include a
395	newline. The module also overwrites the C<warn> builtin with a function
396	that calls this function.
397
398	Using this function has the advantage that its output ends up in the
399	correct place, e.g. on stderr of the connecting urxvtc client.
400
401	=item $is_safe = urxvt::safe
402
403	Returns true when it is safe to do potentially unsafe things, such as
404	evaluating perl code specified by the user. This is true when urxvt was
405	started setuid or setgid.
406
407	=item $time = urxvt::NOW
408
409	Returns the "current time" (as per the event loop).
410
411	=item urxvt::CurrentTime
412
413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415	Button4Mask, Button5Mask, AnyModifier
416
417	Various constants for use in X calls and event processing.
418
419	=back
420
421	=head2 RENDITION
422
423	Rendition bitsets contain information about colour, font, font styles and
424	similar information for each screen cell.
425
426	The following "macros" deal with changes in rendition sets. You should
427	never just create a bitset, you should always modify an existing one,
428	as they contain important information required for correct operation of
429	rxvt-unicode.
430
431	=over 4
432
433	=item $rend = urxvt::DEFAULT_RSTYLE
434
435	Returns the default rendition, as used when the terminal is starting up or
436	being reset. Useful as a base to start when creating renditions.
437
438	=item $rend = urxvt::OVERLAY_RSTYLE
439
440	Return the rendition mask used for overlays by default.
441
442	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
443
444	Return the bit that enabled bold, italic, blink, reverse-video and
445	underline, respectively. To enable such a style, just logically OR it into
446	the bitset.
447
448	=item $foreground = urxvt::GET_BASEFG $rend
449
450	=item $background = urxvt::GET_BASEBG $rend
451
452	Return the foreground/background colour index, respectively.
453
454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455
456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457
458	Replace the foreground/background colour in the rendition mask with the
459	specified one.
460
461	=item $value = urxvt::GET_CUSTOM $rend
462
463	Return the "custom" value: Every rendition has 5 bits for use by
464	extensions. They can be set and changed as you like and are initially
465	zero.
466
467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
468
469	Change the custom value.
470		595
471	=back	596	=back
472		597
473	=cut	598	=cut
474		599
…		…
480	use Scalar::Util ();	605	use Scalar::Util ();
481	use List::Util ();	606	use List::Util ();
482		607
483	our $VERSION = 1;	608	our $VERSION = 1;
484	our $TERM;	609	our $TERM;
		610	our @TERM_INIT;
		611	our @TERM_EXT;
485	our @HOOKNAME;	612	our @HOOKNAME;
486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	613	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
487	our %OPTION;	614	our %OPTION;
488		615
489	our $LIBDIR;	616	our $LIBDIR;
490	our $RESNAME;	617	our $RESNAME;
491	our $RESCLASS;	618	our $RESCLASS;
492	our $RXVTNAME;	619	our $RXVTNAME;
493		620
		621	our $NOCHAR = chr 0xffff;
		622
		623	=head2 Variables in the C<urxvt> Package
		624
		625	=over 4
		626
		627	=item $urxvt::LIBDIR
		628
		629	The rxvt-unicode library directory, where, among other things, the perl
		630	modules and scripts are stored.
		631
		632	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		633
		634	The resource class and name rxvt-unicode uses to look up X resources.
		635
		636	=item $urxvt::RXVTNAME
		637
		638	The basename of the installed binaries, usually C<urxvt>.
		639
		640	=item $urxvt::TERM
		641
		642	The current terminal. This variable stores the current C<urxvt::term>
		643	object, whenever a callback/hook is executing.
		644
		645	=item @urxvt::TERM_INIT
		646
		647	All coderefs in this array will be called as methods of the next newly
		648	created C<urxvt::term> object (during the C<on_init> phase). The array
		649	gets cleared before the codereferences that were in it are being executed,
		650	so coderefs can push themselves onto it again if they so desire.
		651
		652	This complements to the perl-eval commandline option, but gets executed
		653	first.
		654
		655	=item @urxvt::TERM_EXT
		656
		657	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		658	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		659	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		660
		661	=back
		662
		663	=head2 Functions in the C<urxvt> Package
		664
		665	=over 4
		666
		667	=item urxvt::fatal $errormessage
		668
		669	Fatally aborts execution with the given error message. Avoid at all
		670	costs! The only time this is acceptable is when the terminal process
		671	starts up.
		672
		673	=item urxvt::warn $string
		674
		675	Calls C<rxvt_warn> with the given string which should not include a
		676	newline. The module also overwrites the C<warn> builtin with a function
		677	that calls this function.
		678
		679	Using this function has the advantage that its output ends up in the
		680	correct place, e.g. on stderr of the connecting urxvtc client.
		681
		682	Messages have a size limit of 1023 bytes currently.
		683
		684	=item @terms = urxvt::termlist
		685
		686	Returns all urxvt::term objects that exist in this process, regardless of
		687	wether they are started, being destroyed etc., so be careful. Only term
		688	objects that have perl extensions attached will be returned (because there
		689	is no urxvt::term objet associated with others).
		690
		691	=item $time = urxvt::NOW
		692
		693	Returns the "current time" (as per the event loop).
		694
		695	=item urxvt::CurrentTime
		696
		697	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		698	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		699	Button4Mask, Button5Mask, AnyModifier
		700
		701	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		702	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		703	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		704	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		705	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		706	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		707	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		708
		709	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		710	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		711	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		712	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		713	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		714	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		715	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		716
		717	Various constants for use in X calls and event processing.
		718
		719	=back
		720
		721	=head2 RENDITION
		722
		723	Rendition bitsets contain information about colour, font, font styles and
		724	similar information for each screen cell.
		725
		726	The following "macros" deal with changes in rendition sets. You should
		727	never just create a bitset, you should always modify an existing one,
		728	as they contain important information required for correct operation of
		729	rxvt-unicode.
		730
		731	=over 4
		732
		733	=item $rend = urxvt::DEFAULT_RSTYLE
		734
		735	Returns the default rendition, as used when the terminal is starting up or
		736	being reset. Useful as a base to start when creating renditions.
		737
		738	=item $rend = urxvt::OVERLAY_RSTYLE
		739
		740	Return the rendition mask used for overlays by default.
		741
		742	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		743
		744	Return the bit that enabled bold, italic, blink, reverse-video and
		745	underline, respectively. To enable such a style, just logically OR it into
		746	the bitset.
		747
		748	=item $foreground = urxvt::GET_BASEFG $rend
		749
		750	=item $background = urxvt::GET_BASEBG $rend
		751
		752	Return the foreground/background colour index, respectively.
		753
		754	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		755
		756	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		757
		758	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		759
		760	Replace the foreground/background colour in the rendition mask with the
		761	specified one.
		762
		763	=item $value = urxvt::GET_CUSTOM $rend
		764
		765	Return the "custom" value: Every rendition has 5 bits for use by
		766	extensions. They can be set and changed as you like and are initially
		767	zero.
		768
		769	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		770
		771	Change the custom value.
		772
		773	=back
		774
		775	=cut
		776
494	BEGIN {	777	BEGIN {
495	urxvt->bootstrap;
496
497	# overwrite perl's warn	778	# overwrite perl's warn
498	*CORE::GLOBAL::warn = sub {	779	*CORE::GLOBAL::warn = sub {
499	my $msg = join "", @_;	780	my $msg = join "", @_;
500	$msg .= "\n"	781	$msg .= "\n"
501	unless $msg =~ /\n$/;	782	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	783	urxvt::warn ($msg);
503	};	784	};
504
505	delete $ENV{IFS};
506	delete $ENV{CDPATH};
507	delete $ENV{BASH_ENV};
508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509	}	785	}
510		786
511	my @hook_count;	787	no warnings 'utf8';
		788
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	789	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		790
514	sub verbose {	791	sub verbose {
515	my ($level, $msg) = @_;	792	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	793	warn "$msg\n" if $level <= $verbosity;
517	}	794	}
518		795
519	my $extension_pkg = "extension0000";
520	my %extension_pkg;	796	my %extension_pkg;
521		797
522	# load a single script into its own package, once only	798	# load a single script into its own package, once only
523	sub extension_package($) {	799	sub extension_package($) {
524	my ($path) = @_;	800	my ($path) = @_;
525		801
526	$extension_pkg{$path} ||= do {	802	$extension_pkg{$path} ||= do {
527	my $pkg = "urxvt::" . ($extension_pkg++);	803	$path =~ /([^\/\\]+)$/;
		804	my $pkg = $1;
		805	$pkg =~ s/[^[:word:]]/_/g;
		806	$pkg = "urxvt::ext::$pkg";
528		807
529	verbose 3, "loading extension '$path' into package '$pkg'";	808	verbose 3, "loading extension '$path' into package '$pkg'";
530		809
531	open my $fh, "<:raw", $path	810	open my $fh, "<:raw", $path
532	or die "$path: $!";	811	or die "$path: $!";
533		812
534	my $source = untaint	813	my $source =
535	"package $pkg; use strict; use utf8;\n"	814	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
536	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	815	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	816	. (do { local $/; <$fh> })
539	. "\n};\n1";	817	. "\n};\n1";
540		818
541	eval $source	819	eval $source
…		…
555	if ($htype == 0) { # INIT	833	if ($htype == 0) { # INIT
556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	834	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
557		835
558	my %ext_arg;	836	my %ext_arg;
559		837
		838	{
		839	my @init = @TERM_INIT;
		840	@TERM_INIT = ();
		841	$_->($TERM) for @init;
		842	my @pkg = @TERM_EXT;
		843	@TERM_EXT = ();
		844	$TERM->register_package ($_) for @pkg;
		845	}
		846
560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	847	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
561	if ($_ eq "default") {	848	if ($_ eq "default") {
562	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	849	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
563	} elsif (/^-(.*)$/) {	850	} elsif (/^-(.*)$/) {
564	delete $ext_arg{$1};	851	delete $ext_arg{$1};
565	} elsif (/^([^<]+)<(.*)>$/) {	852	} elsif (/^([^<]+)<(.*)>$/) {
566	push @{ $ext_arg{$1} }, $2;	853	push @{ $ext_arg{$1} }, $2;
567	} else {	854	} else {
…		…
590	if $verbosity >= 10;	877	if $verbosity >= 10;
591		878
592	keys %$cb;	879	keys %$cb;
593		880
594	while (my ($pkg, $cb) = each %$cb) {	881	while (my ($pkg, $cb) = each %$cb) {
595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	882	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
596	and last;	883	$retval ||= $retval_;
597		884
598	if ($@) {	885	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	886	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	887	warn $@;
601	}	888	}
602	}	889	}
		890
		891	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		892	if $verbosity >= 11;
603	}	893	}
604		894
605	if ($htype == 1) { # DESTROY	895	if ($htype == 1) { # DESTROY
606	if (my $hook = delete $TERM->{_hook}) {
607	for my $htype (0..$#$hook) {
608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
609	or set_should_invoke $htype, 0;
610	}
611	}
612
613	# clear package objects	896	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	897	%$_ = () for values %{ $TERM->{_pkg} };
615		898
616	# clear package	899	# clear package
617	%$TERM = ();	900	%$TERM = ();
618	}	901	}
619		902
620	$retval	903	$retval
		904	}
		905
		906	sub SET_COLOR($$$) {
		907	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
621	}	908	}
622		909
623	# urxvt::term::extension	910	# urxvt::term::extension
624		911
625	package urxvt::term::extension;	912	package urxvt::term::extension;
…		…
631	while (my ($name, $cb) = each %hook) {	918	while (my ($name, $cb) = each %hook) {
632	my $htype = $HOOKTYPE{uc $name};	919	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	920	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	921	or Carp::croak "unsupported hook type '$name'";
635		922
		923	$self->set_should_invoke ($htype, +1)
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	924	unless exists $self->{term}{_hook}[$htype]{$pkg};
637	$hook_count[$htype]++
638	or urxvt::set_should_invoke $htype, 1;
639	}
640		925
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	926	$self->{term}{_hook}[$htype]{$pkg} = $cb;
642	}	927	}
643	}	928	}
644		929
…		…
649	for my $name (@hook) {	934	for my $name (@hook) {
650	my $htype = $HOOKTYPE{uc $name};	935	my $htype = $HOOKTYPE{uc $name};
651	defined $htype	936	defined $htype
652	or Carp::croak "unsupported hook type '$name'";	937	or Carp::croak "unsupported hook type '$name'";
653		938
		939	$self->set_should_invoke ($htype, -1)
654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	940	if delete $self->{term}{_hook}[$htype]{$pkg};
655	--$hook_count[$htype]
656	or urxvt::set_should_invoke $htype, 0;
657	}
658	}	941	}
659	}	942	}
660		943
661	our $AUTOLOAD;	944	our $AUTOLOAD;
662		945
…		…
768	# find on_xxx subs in the package and register them	1051	# find on_xxx subs in the package and register them
769	# as hooks	1052	# as hooks
770	sub register_package {	1053	sub register_package {
771	my ($self, $pkg, $argv) = @_;	1054	my ($self, $pkg, $argv) = @_;
772		1055
		1056	no strict 'refs';
		1057
		1058	urxvt::verbose 6, "register package $pkg to $self";
		1059
		1060	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1061
773	my $proxy = bless {	1062	my $proxy = bless {
774	_pkg => $pkg,	1063	_pkg => $pkg,
775	argv => $argv,	1064	argv => $argv,
776	}, $pkg;	1065	}, $pkg;
777	Scalar::Util::weaken ($proxy->{term} = $self);	1066	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
783	$proxy->enable ($name => $ref);	1072	$proxy->enable ($name => $ref);
784	}	1073	}
785	}	1074	}
786	}	1075	}
787		1076
		1077	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1078
		1079	Creates a new terminal, very similar as if you had started it with system
		1080	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1081	hash which defines the environment of the new terminal.
		1082
		1083	Croaks (and probably outputs an error message) if the new instance
		1084	couldn't be created. Returns C<undef> if the new instance didn't
		1085	initialise perl, and the terminal object otherwise. The C<init> and
		1086	C<start> hooks will be called before this call returns, and are free to
		1087	refer to global data (which is race free).
		1088
		1089	=cut
		1090
		1091	sub new {
		1092	my ($class, $env, @args) = @_;
		1093
		1094	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1095	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1096
		1097	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1098	}
		1099
788	=item $term->destroy	1100	=item $term->destroy
789		1101
790	Destroy the terminal object (close the window, free resources	1102	Destroy the terminal object (close the window, free resources
791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1103	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792	watchers (timers, io watchers) are still active.	1104	watchers (timers, io watchers) are still active.
793		1105
		1106	=item $term->exec_async ($cmd[, @args])
		1107
		1108	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1109	("starts") programs in the background. This function takes care of setting
		1110	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1111	be preferred over explicit calls to C<exec> or C<system>.
		1112
		1113	Returns the pid of the subprocess or C<undef> on error.
		1114
		1115	=cut
		1116
		1117	sub exec_async {
		1118	my $self = shift;
		1119
		1120	my $pid = fork;
		1121
		1122	return $pid
		1123	if !defined $pid or $pid;
		1124
		1125	%ENV = %{ $self->env };
		1126
		1127	exec @_;
		1128	urxvt::_exit 255;
		1129	}
		1130
794	=item $isset = $term->option ($optval[, $set])	1131	=item $isset = $term->option ($optval[, $set])
795		1132
796	Returns true if the option specified by C<$optval> is enabled, and	1133	Returns true if the option specified by C<$optval> is enabled, and
797	optionally change it. All option values are stored by name in the hash	1134	optionally change it. All option values are stored by name in the hash
798	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1135	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
800	Here is a a likely non-exhaustive list of option names, please see the	1137	Here is a a likely non-exhaustive list of option names, please see the
801	source file F</src/optinc.h> to see the actual list:	1138	source file F</src/optinc.h> to see the actual list:
802		1139
803	borderLess console cursorBlink cursorUnderline hold iconic insecure	1140	borderLess console cursorBlink cursorUnderline hold iconic insecure
804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1141	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1142	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1143	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1144	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808	tripleclickwords utmpInhibit visualBell	1145	transparent tripleclickwords utmpInhibit visualBell
809		1146
810	=item $value = $term->resource ($name[, $newval])	1147	=item $value = $term->resource ($name[, $newval])
811		1148
812	Returns the current resource value associated with a given name and	1149	Returns the current resource value associated with a given name and
813	optionally sets a new value. Setting values is most useful in the C<init>	1150	optionally sets a new value. Setting values is most useful in the C<init>
…		…
830		1167
831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1168	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832	borderLess color cursorBlink cursorUnderline cutchars delete_key	1169	borderLess color cursorBlink cursorUnderline cutchars delete_key
833	display_name embed ext_bwidth fade font geometry hold iconName	1170	display_name embed ext_bwidth fade font geometry hold iconName
834	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1171	imFont imLocale inputMethod insecure int_bwidth intensityStyles
835	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1172	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1173	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1174	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1175	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1176	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1177	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841	shade term_name title transparent transparent_all tripleclickwords	1178	secondaryScreen secondaryScroll selectstyle shade term_name title
842	utmpInhibit visualBell	1179	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1180	visualBell
843		1181
844	=cut	1182	=cut
845		1183
846	sub resource($$;$) {	1184	sub resource($$;$) {
847	my ($self, $name) = (shift, shift);	1185	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1186	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	1187	&urxvt::term::_resource
850	}	1188	}
851		1189
		1190	=item $value = $term->x_resource ($pattern)
		1191
		1192	Returns the X-Resource for the given pattern, excluding the program or
		1193	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1194	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1195	resource with that pattern exists.
		1196
		1197	This method should only be called during the C<on_start> hook, as there is
		1198	only one resource database per display, and later invocations might return
		1199	the wrong resources.
		1200
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1201	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		1202
854	Adds a keymap translation exactly as specified via a resource. See the	1203	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1204	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		1205
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	1220	=item ($row, $col) = $term->selection_end ([$row, $col])
872		1221
873	Return the current values of the selection mark, begin or end positions,	1222	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	1223	and optionally set them to new values.
875		1224
		1225	=item $term->selection_make ($eventtime[, $rectangular])
		1226
		1227	Tries to make a selection as set by C<selection_beg> and
		1228	C<selection_end>. If C<$rectangular> is true (default: false), a
		1229	rectangular selection will be made. This is the prefered function to make
		1230	a selection.
		1231
876	=item $success = $term->selection_grab ($eventtime)	1232	=item $success = $term->selection_grab ($eventtime)
877		1233
878	Try to request the primary selection from the server (for example, as set	1234	Try to request the primary selection text from the server (for example, as
879	by the next method).	1235	set by the next method). No visual feedback will be given. This function
		1236	is mostly useful from within C<on_sel_grab> hooks.
880		1237
881	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext])
882		1239
883	Return the current selection text and optionally replace it by C<$newtext>.	1240	Return the current selection text and optionally replace it by C<$newtext>.
884		1241
…		…
977	Convert the given locale-encoded octets into a perl string.	1334	Convert the given locale-encoded octets into a perl string.
978		1335
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1336	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1337
981	XORs the rendition values in the given span with the provided value	1338	XORs the rendition values in the given span with the provided value
982	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1339	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1340	refresh hooks to provide effects similar to the selection.
984		1341
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1342	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1343
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1344	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1345	whitespace will additionally be xored with the C<$rstyle2>, which defaults
989	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1346	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
990	it instead.	1347	it instead. Both styles I<MUST NOT> contain font styles.
991		1348
992	=item $term->scr_bell	1349	=item $term->scr_bell
993		1350
994	Ring the bell!	1351	Ring the bell!
995		1352
…		…
1002		1359
1003	Normally its not a good idea to use this function, as programs might be	1360	Normally its not a good idea to use this function, as programs might be
1004	confused by changes in cursor position or scrolling. Its useful inside a	1361	confused by changes in cursor position or scrolling. Its useful inside a
1005	C<on_add_lines> hook, though.	1362	C<on_add_lines> hook, though.
1006		1363
		1364	=item $term->scr_change_screen ($screen)
		1365
		1366	Switch to given screen - 0 primary, 1 secondary.
		1367
1007	=item $term->cmd_parse ($octets)	1368	=item $term->cmd_parse ($octets)
1008		1369
1009	Similar to C<scr_add_lines>, but the argument must be in the	1370	Similar to C<scr_add_lines>, but the argument must be in the
1010	locale-specific encoding of the terminal and can contain command sequences	1371	locale-specific encoding of the terminal and can contain command sequences
1011	(escape codes) that will be interpreted.	1372	(escape codes) that will be interpreted.
…		…
1021	Replaces the event mask of the pty watcher by the given event mask. Can	1382	Replaces the event mask of the pty watcher by the given event mask. Can
1022	be used to suppress input and output handling to the pty/tty. See the	1383	be used to suppress input and output handling to the pty/tty. See the
1023	description of C<< urxvt::timer->events >>. Make sure to always restore	1384	description of C<< urxvt::timer->events >>. Make sure to always restore
1024	the previous value.	1385	the previous value.
1025		1386
		1387	=item $fd = $term->pty_fd
		1388
		1389	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1390	is used.
		1391
1026	=item $windowid = $term->parent	1392	=item $windowid = $term->parent
1027		1393
1028	Return the window id of the toplevel window.	1394	Return the window id of the toplevel window.
1029		1395
1030	=item $windowid = $term->vt	1396	=item $windowid = $term->vt
1031		1397
1032	Return the window id of the terminal window.	1398	Return the window id of the terminal window.
1033		1399
		1400	=item $term->vt_emask_add ($x_event_mask)
		1401
		1402	Adds the specified events to the vt event mask. Useful e.g. when you want
		1403	to receive pointer events all the times:
		1404
		1405	$term->vt_emask_add (urxvt::PointerMotionMask);
		1406
		1407	=item $term->focus_in
		1408
		1409	=item $term->focus_out
		1410
		1411	=item $term->key_press ($state, $keycode[, $time])
		1412
		1413	=item $term->key_release ($state, $keycode[, $time])
		1414
		1415	Deliver various fake events to to terminal.
		1416
1034	=item $window_width = $term->width	1417	=item $window_width = $term->width
1035		1418
1036	=item $window_height = $term->height	1419	=item $window_height = $term->height
1037		1420
1038	=item $font_width = $term->fwidth	1421	=item $font_width = $term->fwidth
…		…
1051		1434
1052	=item $max_scrollback = $term->saveLines	1435	=item $max_scrollback = $term->saveLines
1053		1436
1054	=item $nrow_plus_saveLines = $term->total_rows	1437	=item $nrow_plus_saveLines = $term->total_rows
1055		1438
1056	=item $lines_in_scrollback = $term->nsaved	1439	=item $topmost_scrollback_row = $term->top_row
1057		1440
1058	Return various integers describing terminal characteristics.	1441	Return various integers describing terminal characteristics.
1059		1442
		1443	=item $x_display = $term->display_id
		1444
		1445	Return the DISPLAY used by rxvt-unicode.
		1446
1060	=item $lc_ctype = $term->locale	1447	=item $lc_ctype = $term->locale
1061		1448
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1449	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1450
1064	=item $x_display = $term->display_id	1451	=item $env = $term->env
1065		1452
1066	Return the DISPLAY used by rxvt-unicode.	1453	Returns a copy of the environment in effect for the terminal as a hashref
		1454	similar to C<\%ENV>.
		1455
		1456	=cut
		1457
		1458	sub env {
		1459	if (my $env = $_[0]->_env) {
		1460	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1461	} else {
		1462	+{ %ENV }
		1463	}
		1464	}
1067		1465
1068	=item $modifiermask = $term->ModLevel3Mask	1466	=item $modifiermask = $term->ModLevel3Mask
1069		1467
1070	=item $modifiermask = $term->ModMetaMask	1468	=item $modifiermask = $term->ModMetaMask
1071		1469
1072	=item $modifiermask = $term->ModNumLockMask	1470	=item $modifiermask = $term->ModNumLockMask
1073		1471
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1472	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1075	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1473	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1474
		1475	=item $screen = $term->current_screen
		1476
		1477	Returns the currently displayed screen (0 primary, 1 secondary).
		1478
		1479	=item $cursor_is_hidden = $term->hidden_cursor
		1480
		1481	Returns wether the cursor is currently hidden or not.
		1482
1077	=item $view_start = $term->view_start ([$newvalue])	1483	=item $view_start = $term->view_start ([$newvalue])
1078		1484
1079	Returns the negative row number of the topmost line. Minimum value is	1485	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1486	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1487	this many lines into the scrollback buffer.
1082		1488
1083	=item $term->want_refresh	1489	=item $term->want_refresh
1084		1490
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1491	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1100	line, starting at column C<$start_col> (default C<0>), which is useful	1506	line, starting at column C<$start_col> (default C<0>), which is useful
1101	to replace only parts of a line. The font index in the rendition will	1507	to replace only parts of a line. The font index in the rendition will
1102	automatically be updated.	1508	automatically be updated.
1103		1509
1104	C<$text> is in a special encoding: tabs and wide characters that use more	1510	C<$text> is in a special encoding: tabs and wide characters that use more
1105	than one cell when displayed are padded with urxvt::NOCHAR characters	1511	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1106	(C<chr 65535>). Characters with combining characters and other characters	1512	characters. Characters with combining characters and other characters that
1107	that do not fit into the normal tetx encoding will be replaced with	1513	do not fit into the normal tetx encoding will be replaced with characters
1108	characters in the private use area.	1514	in the private use area.
1109		1515
1110	You have to obey this encoding when changing text. The advantage is	1516	You have to obey this encoding when changing text. The advantage is
1111	that C<substr> and similar functions work on screen cells and not on	1517	that C<substr> and similar functions work on screen cells and not on
1112	characters.	1518	characters.
1113		1519
…		…
1164	Return the row number of the first/last row of the line, respectively.	1570	Return the row number of the first/last row of the line, respectively.
1165		1571
1166	=item $offset = $line->offset_of ($row, $col)	1572	=item $offset = $line->offset_of ($row, $col)
1167		1573
1168	Returns the character offset of the given row|col pair within the logical	1574	Returns the character offset of the given row|col pair within the logical
1169	line.	1575	line. Works for rows outside the line, too, and returns corresponding
		1576	offsets outside the string.
1170		1577
1171	=item ($row, $col) = $line->coord_of ($offset)	1578	=item ($row, $col) = $line->coord_of ($offset)
1172		1579
1173	Translates a string offset into terminal coordinates again.	1580	Translates a string offset into terminal coordinates again.
1174		1581
…		…
1259	=item $string = $term->special_decode $text	1666	=item $string = $term->special_decode $text
1260		1667
1261	Converts rxvt-unicodes text reprsentation into a perl string. See	1668	Converts rxvt-unicodes text reprsentation into a perl string. See
1262	C<< $term->ROW_t >> for details.	1669	C<< $term->ROW_t >> for details.
1263		1670
1264	=item $success = $term->grab_button ($button, $modifiermask)	1671	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1265		1672
		1673	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1674
1266	Registers a synchronous button grab. See the XGrabButton manpage.	1675	Register/unregister a synchronous button grab. See the XGrabButton
		1676	manpage.
1267		1677
1268	=item $success = $term->grab ($eventtime[, $sync])	1678	=item $success = $term->grab ($eventtime[, $sync])
1269		1679
1270	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1680	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1271	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1681	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1287		1697
1288	Calls XUngrab for the most recent grab. Is called automatically on	1698	Calls XUngrab for the most recent grab. Is called automatically on
1289	evaluation errors, as it is better to lose the grab in the error case as	1699	evaluation errors, as it is better to lose the grab in the error case as
1290	the session.	1700	the session.
1291		1701
		1702	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1703
		1704	=item $atom_name = $term->XGetAtomName ($atom)
		1705
		1706	=item @atoms = $term->XListProperties ($window)
		1707
		1708	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1709
		1710	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1711
		1712	=item $term->XDeleteProperty ($window, $property)
		1713
		1714	=item $window = $term->DefaultRootWindow
		1715
		1716	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1717
		1718	=item $term->XMapWindow ($window)
		1719
		1720	=item $term->XUnmapWindow ($window)
		1721
		1722	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1723
		1724	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1725
		1726	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1727
		1728	Various X or X-related functions. The C<$term> object only serves as
		1729	the source of the display, otherwise those functions map more-or-less
		1730	directory onto the X functions of the same name.
		1731
1292	=back	1732	=back
1293		1733
1294	=cut	1734	=cut
1295		1735
1296	package urxvt::popup;	1736	package urxvt::popup;
…		…
1310		1750
1311	$item->{render} ||= sub { $_[0]{text} };	1751	$item->{render} ||= sub { $_[0]{text} };
1312		1752
1313	push @{ $self->{item} }, $item;	1753	push @{ $self->{item} }, $item;
1314	}	1754	}
		1755
		1756	=item $popup->add_title ($title)
		1757
		1758	Adds a non-clickable title to the popup.
		1759
		1760	=cut
		1761
		1762	sub add_title {
		1763	my ($self, $title) = @_;
		1764
		1765	$self->add_item ({
		1766	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1767	text => $title,
		1768	activate => sub { },
		1769	});
		1770	}
		1771
		1772	=item $popup->add_separator ([$sepchr])
		1773
		1774	Creates a separator, optionally using the character given as C<$sepchr>.
		1775
		1776	=cut
1315		1777
1316	sub add_separator {	1778	sub add_separator {
1317	my ($self, $sep) = @_;	1779	my ($self, $sep) = @_;
1318		1780
1319	$sep ||= "=";	1781	$sep ||= "=";
…		…
1324	render => sub { $sep x $self->{term}->ncol },	1786	render => sub { $sep x $self->{term}->ncol },
1325	activate => sub { },	1787	activate => sub { },
1326	});	1788	});
1327	}	1789	}
1328		1790
1329	sub add_title {	1791	=item $popup->add_button ($text, $cb)
1330	my ($self, $title) = @_;
1331		1792
1332	$self->add_item ({	1793	Adds a clickable button to the popup. C<$cb> is called whenever it is
1333	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1794	selected.
1334	text => $title,	1795
1335	activate => sub { },	1796	=cut
1336	});
1337	}
1338		1797
1339	sub add_button {	1798	sub add_button {
1340	my ($self, $text, $cb) = @_;	1799	my ($self, $text, $cb) = @_;
1341		1800
1342	$self->add_item ({ type => "button", text => $text, activate => $cb});	1801	$self->add_item ({ type => "button", text => $text, activate => $cb});
1343	}	1802	}
		1803
		1804	=item $popup->add_toggle ($text, $cb, $initial_value)
		1805
		1806	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1807	whenever it gets toggled, with a boolean indicating its value as its first
		1808	argument.
		1809
		1810	=cut
1344		1811
1345	sub add_toggle {	1812	sub add_toggle {
1346	my ($self, $text, $cb, $value) = @_;	1813	my ($self, $text, $cb, $value) = @_;
1347		1814
1348	my $item; $item = {	1815	my $item; $item = {
1349	type => "button",	1816	type => "button",
1350	text => " $text",	1817	text => " $text",
1351	value => $value,	1818	value => $value,
1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1819	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1820	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354	};	1821	};
1355		1822
1356	$self->add_item ($item);	1823	$self->add_item ($item);
1357	}	1824	}
		1825
		1826	=item $popup->show
		1827
		1828	Displays the popup (which is initially hidden).
		1829
		1830	=cut
1358		1831
1359	sub show {	1832	sub show {
1360	my ($self) = @_;	1833	my ($self) = @_;
1361		1834
1362	local $urxvt::popup::self = $self;	1835	local $urxvt::popup::self = $self;
1363		1836
		1837	my $env = $self->{term}->env;
		1838	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1839	delete $env->{LC_ALL};
1364	local $ENV{LC_ALL} = $self->{term}->locale;	1840	$env->{LC_CTYPE} = $self->{term}->locale;
1365		1841
1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1842	urxvt::term->new ($env, "popup",
		1843	"--perl-lib" => "", "--perl-ext-common" => "",
		1844	"-pty-fd" => -1, "-sl" => 0,
		1845	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1367	"--transient-for" => $self->{term}->parent,	1846	"--transient-for" => $self->{term}->parent,
1368	"-display" => $self->{term}->display_id,	1847	"-display" => $self->{term}->display_id,
1369	"-pe" => "urxvt-popup")	1848	"-pe" => "urxvt-popup")
1370	or die "unable to create popup window\n";	1849	or die "unable to create popup window\n";
1371	}	1850	}
1372		1851
1373	sub DESTROY {	1852	sub DESTROY {
1374	my ($self) = @_;	1853	my ($self) = @_;
1375		1854
1376	delete $self->{term}{_destroy}{$self};	1855	delete $self->{term}{_destroy}{$self};
1377	$self->{term}->ungrab;	1856	$self->{term}->ungrab;
1378	}	1857	}
		1858
		1859	=back
		1860
		1861	=cut
		1862
		1863	package urxvt::watcher;
		1864
		1865	@urxvt::timer::ISA = __PACKAGE__;
		1866	@urxvt::iow::ISA = __PACKAGE__;
		1867	@urxvt::pw::ISA = __PACKAGE__;
		1868	@urxvt::iw::ISA = __PACKAGE__;
1379		1869
1380	=head2 The C<urxvt::timer> Class	1870	=head2 The C<urxvt::timer> Class
1381		1871
1382	This class implements timer watchers/events. Time is represented as a	1872	This class implements timer watchers/events. Time is represented as a
1383	fractional number of seconds since the epoch. Example:	1873	fractional number of seconds since the epoch. Example:
…		…
1421	Start the timer.	1911	Start the timer.
1422		1912
1423	=item $timer = $timer->start ($tstamp)	1913	=item $timer = $timer->start ($tstamp)
1424		1914
1425	Set the event trigger time to C<$tstamp> and start the timer.	1915	Set the event trigger time to C<$tstamp> and start the timer.
		1916
		1917	=item $timer = $timer->after ($delay)
		1918
		1919	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1426		1920
1427	=item $timer = $timer->stop	1921	=item $timer = $timer->stop
1428		1922
1429	Stop the timer.	1923	Stop the timer.
1430		1924
…		…
1477		1971
1478	Stop watching for events on the given filehandle.	1972	Stop watching for events on the given filehandle.
1479		1973
1480	=back	1974	=back
1481		1975
		1976	=head2 The C<urxvt::iw> Class
		1977
		1978	This class implements idle watchers, that get called automatically when
		1979	the process is idle. They should return as fast as possible, after doing
		1980	some useful work.
		1981
		1982	=over 4
		1983
		1984	=item $iw = new urxvt::iw
		1985
		1986	Create a new idle watcher object in stopped state.
		1987
		1988	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1989
		1990	Set the callback to be called when the watcher triggers.
		1991
		1992	=item $timer = $timer->start
		1993
		1994	Start the watcher.
		1995
		1996	=item $timer = $timer->stop
		1997
		1998	Stop the watcher.
		1999
		2000	=back
		2001
		2002	=head2 The C<urxvt::pw> Class
		2003
		2004	This class implements process watchers. They create an event whenever a
		2005	process exits, after which they stop automatically.
		2006
		2007	my $pid = fork;
		2008	...
		2009	$term->{pw} = urxvt::pw
		2010	->new
		2011	->start ($pid)
		2012	->cb (sub {
		2013	my ($pw, $exit_status) = @_;
		2014	...
		2015	});
		2016
		2017	=over 4
		2018
		2019	=item $pw = new urxvt::pw
		2020
		2021	Create a new process watcher in stopped state.
		2022
		2023	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2024
		2025	Set the callback to be called when the timer triggers.
		2026
		2027	=item $pw = $timer->start ($pid)
		2028
		2029	Tells the wqtcher to start watching for process C<$pid>.
		2030
		2031	=item $pw = $pw->stop
		2032
		2033	Stop the watcher.
		2034
		2035	=back
		2036
1482	=head1 ENVIRONMENT	2037	=head1 ENVIRONMENT
1483		2038
1484	=head2 URXVT_PERL_VERBOSITY	2039	=head2 URXVT_PERL_VERBOSITY
1485		2040
1486	This variable controls the verbosity level of the perl extension. Higher	2041	This variable controls the verbosity level of the perl extension. Higher
…		…
1490		2045
1491	=item == 0 - fatal messages	2046	=item == 0 - fatal messages
1492		2047
1493	=item >= 3 - script loading and management	2048	=item >= 3 - script loading and management
1494		2049
1495	=item >=10 - all events received	2050	=item >=10 - all called hooks
		2051
		2052	=item >=11 - hook reutrn values
1496		2053
1497	=back	2054	=back
1498		2055
1499	=head1 AUTHOR	2056	=head1 AUTHOR
1500		2057

Diff Legend

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