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.61 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.126 by root, Tue Jan 24 19:14:36 2006 UTC

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

Diff Legend

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