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.63 by root, Mon Jan 9 05:08:02 2006 UTC vs.
Revision 1.124 by root, Sun Jan 22 11:57:06 2006 UTC

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

Diff Legend

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