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.42 by root, Fri Jan 6 21:06:09 2006 UTC vs.
Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
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	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
…		…
56		82
57	URxvt.keysym.C-M-r: perl:selection:rot13	83	URxvt.keysym.C-M-r: perl:selection:rot13
58		84
59	=back	85	=back
60		86
61	=item digital-clock	87	=item option-popup (enabled by default)
62		88
63	Displays a digital clock using the built-in overlay.	89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		90	runtime.
		91
		92	=item selection-popup (enabled by default)
		93
		94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		95	text into various other formats/action (such as uri unescaping, perl
		96	evalution, web-browser starting etc.), depending on content.
		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
		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 selection-autotransform
		133
		134	This selection allows you to do automatic transforms on a selection
		135	whenever a selection is made.
		136
		137	It works by specifying perl snippets (most useful is a single C<s///>
		138	operator) that modify C<$_> as resources:
		139
		140	URxvt.selection-autotransform.0: transform
		141	URxvt.selection-autotransform.1: transform
		142	...
		143
		144	For example, the following will transform selections of the form
		145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		149
		150	And this example matches the same,but replaces it with vi-commands you can
		151	paste directly into your (vi :) editor:
		152
		153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
		166
		167	=item tabbed
		168
		169	This transforms the terminal into a tabbar with additional terminals, that
		170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		172	button per tab.
		173
		174	Clicking a button will activate that tab. Pressing Shift-Left and
		175	Shift-Right will switch to the tab left or right of the current one.
64		176
65	=item mark-urls	177	=item mark-urls
66		178
67	Uses per-line display filtering (C<on_line_update>) to underline urls.	179	Uses per-line display filtering (C<on_line_update>) to underline urls and
		180	make them clickable. When middle-clicked, the program specified in the
		181	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		182	the URL as first argument.
		183
		184	=item automove-background
		185
		186	This is basically a one-line extension that dynamically changes the background pixmap offset
		187	to the window position, in effect creating the same effect as pseudo transparency with
		188	a custom pixmap. No scaling is supported in this mode. Exmaple:
		189
		190	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
68		191
69	=item block-graphics-to-ascii	192	=item block-graphics-to-ascii
70		193
71	A not very useful example of filtering all text output to the terminal,	194	A not very useful example of filtering all text output to the terminal,
72	by replacing all line-drawing characters (U+2500 .. U+259F) by a	195	by replacing all line-drawing characters (U+2500 .. U+259F) by a
73	similar-looking ascii character.	196	similar-looking ascii character.
74		197
		198	=item digital-clock
		199
		200	Displays a digital clock using the built-in overlay.
		201
75	=item example-refresh-hooks	202	=item example-refresh-hooks
76		203
77	Displays a very simple digital clock in the upper right corner of the	204	Displays a very simple digital clock in the upper right corner of the
78	window. Illustrates overwriting the refresh callbacks to create your own	205	window. Illustrates overwriting the refresh callbacks to create your own
79	overlays or changes.	206	overlays or changes.
80		207
		208	=item selection-pastebin
		209
		210	This is a little rarely useful extension that Uploads the selection as
		211	textfile to a remote site (or does other things). (The implementation is
		212	not currently secure for use in a multiuser environment as it writes to
		213	F</tmp> directly.).
		214
		215	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		216	i.e.
		217
		218	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		219
		220	Pressing this combination runs a command with C<%> replaced by the name of
		221	the textfile. This command can be set via a resource:
		222
		223	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		224
		225	And the default is likely not useful to anybody but the few people around
		226	here :)
		227
		228	The name of the textfile is the hex encoded md5 sum of the selection, so
		229	the same content should lead to the same filename.
		230
		231	After a successful upload the selection will be replaced by the text given
		232	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		233	for the filename):
		234
		235	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		236
81	=back	237	=back
		238
		239	=head1 API DOCUMENTATION
82		240
83	=head2 General API Considerations	241	=head2 General API Considerations
84		242
85	All objects (such as terminals, time watchers etc.) are typical	243	All objects (such as terminals, time watchers etc.) are typical
86	reference-to-hash objects. The hash can be used to store anything you	244	reference-to-hash objects. The hash can be used to store anything you
…		…
99	=over 4	257	=over 4
100		258
101	=item $text	259	=item $text
102		260
103	Rxvt-unicodes special way of encoding text, where one "unicode" character	261	Rxvt-unicodes special way of encoding text, where one "unicode" character
104	always represents one screen cell. See L<row_t> for a discussion of this format.	262	always represents one screen cell. See L<ROW_t> for a discussion of this format.
105		263
106	=item $string	264	=item $string
107		265
108	A perl text string, with an emphasis on I<text>. It can store all unicode	266	A perl text string, with an emphasis on I<text>. It can store all unicode
109	characters and is to be distinguished with text encoded in a specific	267	characters and is to be distinguished with text encoded in a specific
…		…
114	Either binary data or - more common - a text string encoded in a	272	Either binary data or - more common - a text string encoded in a
115	locale-specific way.	273	locale-specific way.
116		274
117	=back	275	=back
118		276
		277	=head2 Extension Objects
		278
		279	Very perl extension is a perl class. A separate perl object is created
		280	for each terminal and each extension and passed as the first parameter to
		281	hooks. So extensions can use their C<$self> object without having to think
		282	about other extensions, with the exception of methods and members that
		283	begin with an underscore character C<_>: these are reserved for internal
		284	use.
		285
		286	Although it isn't a C<urxvt::term> object, you can call all methods of the
		287	C<urxvt::term> class on this object.
		288
		289	It has the following methods and data members:
		290
		291	=over 4
		292
		293	=item $urxvt_term = $self->{term}
		294
		295	Returns the C<urxvt::term> object associated with this instance of the
		296	extension. This member I<must not> be changed in any way.
		297
		298	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		299
		300	Dynamically enable the given hooks (named without the C<on_> prefix) for
		301	this extension, replacing any previous hook. This is useful when you want
		302	to overwrite time-critical hooks only temporarily.
		303
		304	=item $self->disable ($hook_name[, $hook_name..])
		305
		306	Dynamically disable the given hooks.
		307
		308	=back
		309
119	=head2 Hooks	310	=head2 Hooks
120		311
121	The following subroutines can be declared in loaded scripts, and will be	312	The following subroutines can be declared in extension files, and will be
122	called whenever the relevant event happens.	313	called whenever the relevant event happens.
123		314
124	The first argument passed to them is an object private to each terminal	315	The first argument passed to them is an extension oject as described in
125	and extension package. You can call all C<urxvt::term> methods on it, but	316	the in the C<Extension Objects> section.
126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127	object that is shared between all packages is stored in the C<term>
128	member.
129		317
130	All of them must return a boolean value. If it is true, then the event	318	B<All> of these hooks must return a boolean value. If any of the called
131	counts as being I<consumed>, and the invocation of other hooks is skipped,	319	hooks returns true, then the event counts as being I<consumed>, and the
132	and the relevant action might not be carried out by the C++ code.	320	relevant action might not be carried out by the C++ code.
133		321
134	When in doubt, return a false value (preferably C<()>).	322	I<< When in doubt, return a false value (preferably C<()>). >>
135		323
136	=over 4	324	=over 4
137		325
138	=item on_init $term	326	=item on_init $term
139		327
140	Called after a new terminal object has been initialized, but before	328	Called after a new terminal object has been initialized, but before
141	windows are created or the command gets run. Most methods are unsafe to	329	windows are created or the command gets run. Most methods are unsafe to
142	call or deliver senseless data, as terminal size and other characteristics	330	call or deliver senseless data, as terminal size and other characteristics
143	have not yet been determined. You can safely query and change resources,	331	have not yet been determined. You can safely query and change resources
144	though.	332	and options, though. For many purposes the C<on_start> hook is a better
		333	place.
		334
		335	=item on_start $term
		336
		337	Called at the very end of initialisation of a new terminal, just before
		338	trying to map (display) the toplevel and returning to the mainloop.
		339
		340	=item on_destroy $term
		341
		342	Called whenever something tries to destroy terminal, before doing anything
		343	yet. If this hook returns true, then destruction is skipped, but this is
		344	rarely a good idea.
145		345
146	=item on_reset $term	346	=item on_reset $term
147		347
148	Called after the screen is "reset" for any reason, such as resizing or	348	Called after the screen is "reset" for any reason, such as resizing or
149	control sequences. Here is where you can react on changes to size-related	349	control sequences. Here is where you can react on changes to size-related
150	variables.	350	variables.
151		351
152	=item on_start $term	352	=item on_child_start $term, $pid
153		353
154	Called at the very end of initialisation of a new terminal, just before	354	Called just after the child process has been C<fork>ed.
155	returning to the mainloop.	355
		356	=item on_child_exit $term, $status
		357
		358	Called just after the child process has exited. C<$status> is the status
		359	from C<waitpid>.
156		360
157	=item on_sel_make $term, $eventtime	361	=item on_sel_make $term, $eventtime
158		362
159	Called whenever a selection has been made by the user, but before the	363	Called whenever a selection has been made by the user, but before the
160	selection text is copied, so changes to the beginning, end or type of the	364	selection text is copied, so changes to the beginning, end or type of the
…		…
174	=item on_sel_extend $term	378	=item on_sel_extend $term
175		379
176	Called whenever the user tries to extend the selection (e.g. with a double	380	Called whenever the user tries to extend the selection (e.g. with a double
177	click) and is either supposed to return false (normal operation), or	381	click) and is either supposed to return false (normal operation), or
178	should extend the selection itelf and return true to suppress the built-in	382	should extend the selection itelf and return true to suppress the built-in
179	processing.	383	processing. This can happen multiple times, as long as the callback
		384	returns true, it will be called on every further click by the user and is
		385	supposed to enlarge the selection more and more, if possible.
180		386
181	See the F<selection> example extension.	387	See the F<selection> example extension.
182
183	=item on_focus_in $term
184
185	Called whenever the window gets the keyboard focus, before urxvt does
186	focus in processing.
187
188	=item on_focus_out $term
189
190	Called wheneever the window loses keyboard focus, before urxvt does focus
191	out processing.
192		388
193	=item on_view_change $term, $offset	389	=item on_view_change $term, $offset
194		390
195	Called whenever the view offset changes, i..e the user or program	391	Called whenever the view offset changes, i..e the user or program
196	scrolls. Offset C<0> means display the normal terminal, positive values	392	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
203	than the scroll back buffer or the terminal.	399	than the scroll back buffer or the terminal.
204		400
205	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	401	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
206	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	402	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
207	number of lines that will be in the scrollback buffer.	403	number of lines that will be in the scrollback buffer.
208
209	=item on_tty_activity $term *NYI*
210
211	Called whenever the program(s) running in the urxvt window send output.
212		404
213	=item on_osc_seq $term, $string	405	=item on_osc_seq $term, $string
214		406
215	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	407	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
216	operating system command) is processed. Cursor position and other state	408	operating system command) is processed. Cursor position and other state
…		…
229	can filter/change and output the text yourself by returning a true value	421	can filter/change and output the text yourself by returning a true value
230	and calling C<< $term->scr_add_lines >> yourself. Please note that this	422	and calling C<< $term->scr_add_lines >> yourself. Please note that this
231	might be very slow, however, as your hook is called for B<all> text being	423	might be very slow, however, as your hook is called for B<all> text being
232	output.	424	output.
233		425
		426	=item on_tt_write $term, $octets
		427
		428	Called whenever some data is written to the tty/pty and can be used to
		429	suppress or filter tty input.
		430
234	=item on_line_update $term, $row	431	=item on_line_update $term, $row
235		432
236	Called whenever a line was updated or changed. Can be used to filter	433	Called whenever a line was updated or changed. Can be used to filter
237	screen output (e.g. underline urls or other useless stuff). Only lines	434	screen output (e.g. underline urls or other useless stuff). Only lines
238	that are being shown will be filtered, and, due to performance reasons,	435	that are being shown will be filtered, and, due to performance reasons,
…		…
260		457
261	Called whenever the user presses a key combination that has a	458	Called whenever the user presses a key combination that has a
262	C<perl:string> action bound to it (see description of the B<keysym>	459	C<perl:string> action bound to it (see description of the B<keysym>
263	resource in the @@RXVT_NAME@@(1) manpage).	460	resource in the @@RXVT_NAME@@(1) manpage).
264		461
		462	=item on_x_event $term, $event
		463
		464	Called on every X event received on the vt window (and possibly other
		465	windows). Should only be used as a last resort. Most event structure
		466	members are not passed.
		467
		468	=item on_focus_in $term
		469
		470	Called whenever the window gets the keyboard focus, before rxvt-unicode
		471	does focus in processing.
		472
		473	=item on_focus_out $term
		474
		475	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		476	focus out processing.
		477
		478	=item on_configure_notify $term, $event
		479
265	=item on_key_press $term, $event, $octets	480	=item on_key_press $term, $event, $keysym, $octets
266		481
267	=item on_key_release $term, $event	482	=item on_key_release $term, $event, $keysym
268		483
269	=item on_button_press $term, $event	484	=item on_button_press $term, $event
270		485
271	=item on_button_release $term, $event	486	=item on_button_release $term, $event
272		487
273	=item on_motion_notify $term, $event	488	=item on_motion_notify $term, $event
		489
		490	=item on_map_notify $term, $event
		491
		492	=item on_unmap_notify $term, $event
274		493
275	Called whenever the corresponding X event is received for the terminal If	494	Called whenever the corresponding X event is received for the terminal If
276	the hook returns true, then the even will be ignored by rxvt-unicode.	495	the hook returns true, then the even will be ignored by rxvt-unicode.
277		496
278	The event is a hash with most values as named by Xlib (see the XEvent	497	The event is a hash with most values as named by Xlib (see the XEvent
…		…
282	C<on_key_press> additionally receives the string rxvt-unicode would	501	C<on_key_press> additionally receives the string rxvt-unicode would
283	output, if any, in locale-specific encoding.	502	output, if any, in locale-specific encoding.
284		503
285	subwindow.	504	subwindow.
286		505
		506	=item on_client_message $term, $event
		507
		508	=item on_wm_protocols $term, $event
		509
		510	=item on_wm_delete_window $term, $event
		511
		512	Called when various types of ClientMessage events are received (all with
		513	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		514
287	=back	515	=back
288		516
		517	=cut
		518
		519	package urxvt;
		520
		521	use utf8;
		522	use strict;
		523	use Carp ();
		524	use Scalar::Util ();
		525	use List::Util ();
		526
		527	our $VERSION = 1;
		528	our $TERM;
		529	our @TERM_INIT;
		530	our @TERM_EXT;
		531	our @HOOKNAME;
		532	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		533	our %OPTION;
		534
		535	our $LIBDIR;
		536	our $RESNAME;
		537	our $RESCLASS;
		538	our $RXVTNAME;
		539
289	=head2 Variables in the C<urxvt> Package	540	=head2 Variables in the C<urxvt> Package
290		541
291	=over 4	542	=over 4
292		543
		544	=item $urxvt::LIBDIR
		545
		546	The rxvt-unicode library directory, where, among other things, the perl
		547	modules and scripts are stored.
		548
		549	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		550
		551	The resource class and name rxvt-unicode uses to look up X resources.
		552
		553	=item $urxvt::RXVTNAME
		554
		555	The basename of the installed binaries, usually C<urxvt>.
		556
293	=item $urxvt::TERM	557	=item $urxvt::TERM
294		558
295	The current terminal. Whenever a callback/Hook is bein executed, this	559	The current terminal. This variable stores the current C<urxvt::term>
296	variable stores the current C<urxvt::term> object.	560	object, whenever a callback/hook is executing.
		561
		562	=item @urxvt::TERM_INIT
		563
		564	All coderefs in this array will be called as methods of the next newly
		565	created C<urxvt::term> object (during the C<on_init> phase). The array
		566	gets cleared before the codereferences that were in it are being executed,
		567	so coderefs can push themselves onto it again if they so desire.
		568
		569	This complements to the perl-eval commandline option, but gets executed
		570	first.
		571
		572	=item @urxvt::TERM_EXT
		573
		574	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		575	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		576	but before other extensions. Gets cleared just like C<@TERM_INIT>.
297		577
298	=back	578	=back
299		579
300	=head2 Functions in the C<urxvt> Package	580	=head2 Functions in the C<urxvt> Package
301		581
302	=over 4	582	=over 4
303
304	=item $term = new urxvt [arg...]
305
306	Creates a new terminal, very similar as if you had started it with
307	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
308	if the new instance couldn't be created. Returns C<undef> if the new
309	instance didn't initialise perl, and the terminal object otherwise. The
310	C<init> and C<start> hooks will be called during the call.
311		583
312	=item urxvt::fatal $errormessage	584	=item urxvt::fatal $errormessage
313		585
314	Fatally aborts execution with the given error message. Avoid at all	586	Fatally aborts execution with the given error message. Avoid at all
315	costs! The only time this is acceptable is when the terminal process	587	costs! The only time this is acceptable is when the terminal process
…		…
322	that calls this function.	594	that calls this function.
323		595
324	Using this function has the advantage that its output ends up in the	596	Using this function has the advantage that its output ends up in the
325	correct place, e.g. on stderr of the connecting urxvtc client.	597	correct place, e.g. on stderr of the connecting urxvtc client.
326		598
		599	Messages have a size limit of 1023 bytes currently.
		600
327	=item $time = urxvt::NOW	601	=item $time = urxvt::NOW
328		602
329	Returns the "current time" (as per the event loop).	603	Returns the "current time" (as per the event loop).
		604
		605	=item urxvt::CurrentTime
		606
		607	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		608	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		609	Button4Mask, Button5Mask, AnyModifier
		610
		611	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		612	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		613	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		614	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		615	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		616	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		617	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		618
		619	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		620	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		621	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		622	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		623	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		624	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		625	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		626
		627	Various constants for use in X calls and event processing.
330		628
331	=back	629	=back
332		630
333	=head2 RENDITION	631	=head2 RENDITION
334		632
…		…
361		659
362	=item $background = urxvt::GET_BASEBG $rend	660	=item $background = urxvt::GET_BASEBG $rend
363		661
364	Return the foreground/background colour index, respectively.	662	Return the foreground/background colour index, respectively.
365		663
366	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	664	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
367		665
368	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	666	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
369		667
370	Replace the foreground/background colour in the rendition mask with the	668	Replace the foreground/background colour in the rendition mask with the
371	specified one.	669	specified one.
372		670
373	=item $value = urxvt::GET_CUSTOM ($rend)	671	=item $value = urxvt::GET_CUSTOM $rend
374		672
375	Return the "custom" value: Every rendition has 5 bits for use by	673	Return the "custom" value: Every rendition has 5 bits for use by
376	extensions. They can be set and changed as you like and are initially	674	extensions. They can be set and changed as you like and are initially
377	zero.	675	zero.
378		676
379	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	677	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
380		678
381	Change the custom value.	679	Change the custom value.
382		680
383	=back	681	=back
384		682
385	=cut	683	=cut
386		684
387	package urxvt;
388
389	use strict;
390	use Scalar::Util ();
391
392	our $TERM;
393	our @HOOKNAME;
394	our $LIBDIR;
395
396	BEGIN {	685	BEGIN {
397	urxvt->bootstrap;
398
399	# overwrite perl's warn	686	# overwrite perl's warn
400	*CORE::GLOBAL::warn = sub {	687	*CORE::GLOBAL::warn = sub {
401	my $msg = join "", @_;	688	my $msg = join "", @_;
402	$msg .= "\n"	689	$msg .= "\n"
403	unless $msg =~ /\n$/;	690	unless $msg =~ /\n$/;
404	urxvt::warn ($msg);	691	urxvt::warn ($msg);
405	};	692	};
406	}	693	}
407		694
408	my @hook_count;
409	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	695	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
410		696
411	sub verbose {	697	sub verbose {
412	my ($level, $msg) = @_;	698	my ($level, $msg) = @_;
413	warn "$msg\n" if $level <= $verbosity;	699	warn "$msg\n" if $level <= $verbosity;
414	}	700	}
415		701
416	# find on_xxx subs in the package and register them	702	my %extension_pkg;
417	# as hooks
418	sub register_package($) {
419	my ($pkg) = @_;
420
421	for my $htype (0.. $#HOOKNAME) {
422	my $name = $HOOKNAME[$htype];
423
424	my $ref = $pkg->can ("on_" . lc $name)
425	or next;
426
427	$TERM->{_hook}[$htype]{$pkg} = $ref;
428	$hook_count[$htype]++
429	or set_should_invoke $htype, 1;
430	}
431	}
432
433	my $script_pkg = "script0000";
434	my %script_pkg;
435		703
436	# load a single script into its own package, once only	704	# load a single script into its own package, once only
437	sub script_package($) {	705	sub extension_package($) {
438	my ($path) = @_;	706	my ($path) = @_;
439		707
440	$script_pkg{$path} ||= do {	708	$extension_pkg{$path} ||= do {
441	my $pkg = "urxvt::" . ($script_pkg++);	709	$path =~ /([^\/\\]+)$/;
		710	my $pkg = $1;
		711	$pkg =~ s/[^[:word:]]/_/g;
		712	$pkg = "urxvt::ext::$pkg";
442		713
443	verbose 3, "loading script '$path' into package '$pkg'";	714	verbose 3, "loading extension '$path' into package '$pkg'";
444		715
445	open my $fh, "<:raw", $path	716	open my $fh, "<:raw", $path
446	or die "$path: $!";	717	or die "$path: $!";
447		718
		719	my $source =
448	my $source = "package $pkg; use strict; use utf8;\n"	720	"package $pkg; use strict; use utf8;\n"
449	. "#line 1 \"$path\"\n{\n"	721	. "#line 1 \"$path\"\n{\n"
450	. (do { local $/; <$fh> })	722	. (do { local $/; <$fh> })
451	. "\n};\n1";	723	. "\n};\n1";
452		724
		725	eval $source
453	eval $source or die "$path: $@";	726	or die "$path: $@";
454		727
455	$pkg	728	$pkg
456	}	729	}
457	}	730	}
458		731
…		…
463	local $TERM = shift;	736	local $TERM = shift;
464	my $htype = shift;	737	my $htype = shift;
465		738
466	if ($htype == 0) { # INIT	739	if ($htype == 0) { # INIT
467	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	740	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		741
		742	my %ext_arg;
468		743
		744	{
		745	my @init = @TERM_INIT;
		746	@TERM_INIT = ();
		747	$_->($TERM) for @init;
		748	my @pkg = @TERM_EXT;
		749	@TERM_EXT = ();
		750	$TERM->register_package ($_) for @pkg;
		751	}
		752
469	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	753	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		754	if ($_ eq "default") {
		755	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
		756	} elsif (/^-(.*)$/) {
		757	delete $ext_arg{$1};
		758	} elsif (/^([^<]+)<(.*)>$/) {
		759	push @{ $ext_arg{$1} }, $2;
		760	} else {
		761	$ext_arg{$_} ||= [];
		762	}
		763	}
		764
		765	while (my ($ext, $argv) = each %ext_arg) {
470	my @files = grep -f $_, map "$_/$ext", @dirs;	766	my @files = grep -f $_, map "$_/$ext", @dirs;
471		767
472	if (@files) {	768	if (@files) {
473	register_package script_package $files[0];	769	$TERM->register_package (extension_package $files[0], $argv);
474	} else {	770	} else {
475	warn "perl extension '$ext' not found in perl library search path\n";	771	warn "perl extension '$ext' not found in perl library search path\n";
476	}	772	}
477	}	773	}
		774
		775	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		776	warn $@ if $@;
478	}	777	}
479		778
480	$retval = undef;	779	$retval = undef;
481		780
482	if (my $cb = $TERM->{_hook}[$htype]) {	781	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
484	if $verbosity >= 10;	783	if $verbosity >= 10;
485		784
486	keys %$cb;	785	keys %$cb;
487		786
488	while (my ($pkg, $cb) = each %$cb) {	787	while (my ($pkg, $cb) = each %$cb) {
489	$retval = $cb->(	788	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
490	$TERM->{_pkg}{$pkg} ||= do {	789	$retval ||= $retval_;
491	my $proxy = bless { }, urxvt::term::proxy::;
492	Scalar::Util::weaken ($proxy->{term} = $TERM);
493	$proxy
494	},
495	@_,
496	) and last;
497	}
498	}
499		790
500	if ($htype == 1) { # DESTROY	791	if ($@) {
501	# remove hooks if unused	792	$TERM->ungrab; # better to lose the grab than the session
502	if (my $hook = $TERM->{_hook}) {	793	warn $@;
503	for my $htype (0..$#$hook) {
504	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
505	or set_should_invoke $htype, 0;
506	}	794	}
507	}	795	}
508		796
		797	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		798	if $verbosity >= 11;
		799	}
		800
		801	if ($htype == 1) { # DESTROY
509	# clear package objects	802	# clear package objects
510	%$_ = () for values %{ $TERM->{_pkg} };	803	%$_ = () for values %{ $TERM->{_pkg} };
511		804
512	# clear package	805	# clear package
513	%$TERM = ();	806	%$TERM = ();
514	}	807	}
515		808
516	$retval	809	$retval
517	}	810	}
518		811
519	sub urxvt::term::proxy::AUTOLOAD {	812	# urxvt::term::extension
520	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	813
		814	package urxvt::term::extension;
		815
		816	sub enable {
		817	my ($self, %hook) = @_;
		818	my $pkg = $self->{_pkg};
		819
		820	while (my ($name, $cb) = each %hook) {
		821	my $htype = $HOOKTYPE{uc $name};
		822	defined $htype
		823	or Carp::croak "unsupported hook type '$name'";
		824
		825	$self->set_should_invoke ($htype, +1)
		826	unless exists $self->{term}{_hook}[$htype]{$pkg};
		827
		828	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		829	}
		830	}
		831
		832	sub disable {
		833	my ($self, @hook) = @_;
		834	my $pkg = $self->{_pkg};
		835
		836	for my $name (@hook) {
		837	my $htype = $HOOKTYPE{uc $name};
		838	defined $htype
		839	or Carp::croak "unsupported hook type '$name'";
		840
		841	$self->set_should_invoke ($htype, -1)
		842	if delete $self->{term}{_hook}[$htype]{$pkg};
		843	}
		844	}
		845
		846	our $AUTOLOAD;
		847
		848	sub AUTOLOAD {
		849	$AUTOLOAD =~ /:([^:]+)$/
521	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	850	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
522		851
523	eval qq{	852	eval qq{
524	sub $urxvt::term::proxy::AUTOLOAD {	853	sub $AUTOLOAD {
525	my \$proxy = shift;	854	my \$proxy = shift;
526	\$proxy->{term}->$1 (\@_)	855	\$proxy->{term}->$1 (\@_)
527	}	856	}
528	1	857	1
529	} or die "FATAL: unable to compile method forwarder: $@";	858	} or die "FATAL: unable to compile method forwarder: $@";
530		859
531	goto &$urxvt::term::proxy::AUTOLOAD;	860	goto &$AUTOLOAD;
532	}	861	}
		862
		863	sub DESTROY {
		864	# nop
		865	}
		866
		867	# urxvt::destroy_hook
		868
		869	sub urxvt::destroy_hook::DESTROY {
		870	${$_[0]}->();
		871	}
		872
		873	sub urxvt::destroy_hook(&) {
		874	bless \shift, urxvt::destroy_hook::
		875	}
		876
		877	package urxvt::anyevent;
		878
		879	=head2 The C<urxvt::anyevent> Class
		880
		881	The sole purpose of this class is to deliver an interface to the
		882	C<AnyEvent> module - any module using it will work inside urxvt without
		883	further programming. The only exception is that you cannot wait on
		884	condition variables, but non-blocking condvar use is ok. What this means
		885	is that you cannot use blocking APIs, but the non-blocking variant should
		886	work.
		887
		888	=cut
		889
		890	our $VERSION = 1;
		891
		892	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		893	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		894
		895	sub timer {
		896	my ($class, %arg) = @_;
		897
		898	my $cb = $arg{cb};
		899
		900	urxvt::timer
		901	->new
		902	->start (urxvt::NOW + $arg{after})
		903	->cb (sub {
		904	$_[0]->stop; # need to cancel manually
		905	$cb->();
		906	})
		907	}
		908
		909	sub io {
		910	my ($class, %arg) = @_;
		911
		912	my $cb = $arg{cb};
		913
		914	bless [$arg{fh}, urxvt::iow
		915	->new
		916	->fd (fileno $arg{fh})
		917	->events (($arg{poll} =~ /r/ ? 1 : 0)
		918	| ($arg{poll} =~ /w/ ? 2 : 0))
		919	->start
		920	->cb (sub {
		921	$cb->(($_[1] & 1 ? 'r' : '')
		922	. ($_[1] & 2 ? 'w' : ''));
		923	})],
		924	urxvt::anyevent::
		925	}
		926
		927	sub DESTROY {
		928	$_[0][1]->stop;
		929	}
		930
		931	sub condvar {
		932	bless \my $flag, urxvt::anyevent::condvar::
		933	}
		934
		935	sub urxvt::anyevent::condvar::broadcast {
		936	${$_[0]}++;
		937	}
		938
		939	sub urxvt::anyevent::condvar::wait {
		940	unless (${$_[0]}) {
		941	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		942	}
		943	}
		944
		945	package urxvt::term;
533		946
534	=head2 The C<urxvt::term> Class	947	=head2 The C<urxvt::term> Class
535		948
536	=over 4	949	=over 4
537		950
		951	=cut
		952
		953	# find on_xxx subs in the package and register them
		954	# as hooks
		955	sub register_package {
		956	my ($self, $pkg, $argv) = @_;
		957
		958	no strict 'refs';
		959
		960	urxvt::verbose 6, "register package $pkg to $self";
		961
		962	@{"$pkg\::ISA"} = urxvt::term::extension::;
		963
		964	my $proxy = bless {
		965	_pkg => $pkg,
		966	argv => $argv,
		967	}, $pkg;
		968	Scalar::Util::weaken ($proxy->{term} = $self);
		969
		970	$self->{_pkg}{$pkg} = $proxy;
		971
		972	for my $name (@HOOKNAME) {
		973	if (my $ref = $pkg->can ("on_" . lc $name)) {
		974	$proxy->enable ($name => $ref);
		975	}
		976	}
		977	}
		978
		979	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		980
		981	Creates a new terminal, very similar as if you had started it with system
		982	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		983	hash which defines the environment of the new terminal.
		984
		985	Croaks (and probably outputs an error message) if the new instance
		986	couldn't be created. Returns C<undef> if the new instance didn't
		987	initialise perl, and the terminal object otherwise. The C<init> and
		988	C<start> hooks will be called during this call.
		989
		990	=cut
		991
		992	sub new {
		993	my ($class, $env, @args) = @_;
		994
		995	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		996	}
		997
538	=item $term->destroy	998	=item $term->destroy
539		999
540	Destroy the terminal object (close the window, free resources etc.).	1000	Destroy the terminal object (close the window, free resources
		1001	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1002	watchers (timers, io watchers) are still active.
		1003
		1004	=item $term->exec_async ($cmd[, @args])
		1005
		1006	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1007	("starts") programs in the background. This function takes care of setting
		1008	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1009	be preferred over explicit calls to C<exec> or C<system>.
		1010
		1011	Returns the pid of the subprocess or C<undef> on error.
		1012
		1013	=cut
		1014
		1015	sub exec_async {
		1016	my $self = shift;
		1017
		1018	my $pid = fork;
		1019
		1020	return $pid
		1021	if !defined $pid or $pid;
		1022
		1023	%ENV = %{ $self->env };
		1024
		1025	exec @_;
		1026	urxvt::_exit 255;
		1027	}
		1028
		1029	=item $isset = $term->option ($optval[, $set])
		1030
		1031	Returns true if the option specified by C<$optval> is enabled, and
		1032	optionally change it. All option values are stored by name in the hash
		1033	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		1034
		1035	Here is a a likely non-exhaustive list of option names, please see the
		1036	source file F</src/optinc.h> to see the actual list:
		1037
		1038	borderLess console cursorBlink cursorUnderline hold iconic insecure
		1039	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		1040	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
		1041	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
		1042	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
		1043	transparent tripleclickwords utmpInhibit visualBell
541		1044
542	=item $value = $term->resource ($name[, $newval])	1045	=item $value = $term->resource ($name[, $newval])
543		1046
544	Returns the current resource value associated with a given name and	1047	Returns the current resource value associated with a given name and
545	optionally sets a new value. Setting values is most useful in the C<init>	1048	optionally sets a new value. Setting values is most useful in the C<init>
…		…
555		1058
556	Please note that resource strings will currently only be freed when the	1059	Please note that resource strings will currently only be freed when the
557	terminal is destroyed, so changing options frequently will eat memory.	1060	terminal is destroyed, so changing options frequently will eat memory.
558		1061
559	Here is a a likely non-exhaustive list of resource names, not all of which	1062	Here is a a likely non-exhaustive list of resource names, not all of which
560	are supported in every build, please see the source to see the actual	1063	are supported in every build, please see the source file F</src/rsinc.h>
561	list:	1064	to see the actual list:
562		1065
563	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1066	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
564	borderLess color cursorBlink cursorUnderline cutchars delete_key	1067	borderLess color cursorBlink cursorUnderline cutchars delete_key
565	display_name embed ext_bwidth fade font geometry hold iconName	1068	display_name embed ext_bwidth fade font geometry hold iconName
566	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1069	imFont imLocale inputMethod insecure int_bwidth intensityStyles
567	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1070	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
568	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1071	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
569	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1072	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
570	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1073	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
571	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1074	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
572	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1075	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
573	shade term_name title transparent transparent_all tripleclickwords	1076	secondaryScreen secondaryScroll selectstyle shade term_name title
574	utmpInhibit visualBell	1077	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1078	visualBell
575		1079
576	=cut	1080	=cut
577		1081
578	sub urxvt::term::resource($$;$) {	1082	sub resource($$;$) {
579	my ($self, $name) = (shift, shift);	1083	my ($self, $name) = (shift, shift);
580	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1084	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
581	goto &urxvt::term::_resource;	1085	&urxvt::term::_resource
582	}	1086	}
		1087
		1088	=item $value = $term->x_resource ($pattern)
		1089
		1090	Returns the X-Resource for the given pattern, excluding the program or
		1091	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1092	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1093	resource with that pattern exists.
		1094
		1095	This method should only be called during the C<on_start> hook, as there is
		1096	only one resource database per display, and later invocations might return
		1097	the wrong resources.
		1098
		1099	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1100
		1101	Adds a keymap translation exactly as specified via a resource. See the
		1102	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
583		1103
584	=item $rend = $term->rstyle ([$new_rstyle])	1104	=item $rend = $term->rstyle ([$new_rstyle])
585		1105
586	Return and optionally change the current rendition. Text that is output by	1106	Return and optionally change the current rendition. Text that is output by
587	the terminal application will use this style.	1107	the terminal application will use this style.
…		…
598	=item ($row, $col) = $term->selection_end ([$row, $col])	1118	=item ($row, $col) = $term->selection_end ([$row, $col])
599		1119
600	Return the current values of the selection mark, begin or end positions,	1120	Return the current values of the selection mark, begin or end positions,
601	and optionally set them to new values.	1121	and optionally set them to new values.
602		1122
		1123	=item $term->selection_make ($eventtime[, $rectangular])
		1124
		1125	Tries to make a selection as set by C<selection_beg> and
		1126	C<selection_end>. If C<$rectangular> is true (default: false), a
		1127	rectangular selection will be made. This is the prefered function to make
		1128	a selection.
		1129
603	=item $success = $term->selection_grab ($eventtime)	1130	=item $success = $term->selection_grab ($eventtime)
604		1131
605	Try to request the primary selection from the server (for example, as set	1132	Try to request the primary selection text from the server (for example, as
606	by the next method).	1133	set by the next method). No visual feedback will be given. This function
		1134	is mostly useful from within C<on_sel_grab> hooks.
607		1135
608	=item $oldtext = $term->selection ([$newtext])	1136	=item $oldtext = $term->selection ([$newtext])
609		1137
610	Return the current selection text and optionally replace it by C<$newtext>.	1138	Return the current selection text and optionally replace it by C<$newtext>.
611		1139
612	#=item $term->overlay ($x, $y, $text)	1140	=item $term->overlay_simple ($x, $y, $text)
613	#	1141
614	#Create a simple multi-line overlay box. See the next method for details.	1142	Create a simple multi-line overlay box. See the next method for details.
615	#	1143
616	#=cut	1144	=cut
617	#	1145
618	#sub urxvt::term::scr_overlay {	1146	sub overlay_simple {
619	# my ($self, $x, $y, $text) = @_;	1147	my ($self, $x, $y, $text) = @_;
620	#	1148
621	# my @lines = split /\n/, $text;	1149	my @lines = split /\n/, $text;
622	#	1150
623	# my $w = 0;	1151	my $w = List::Util::max map $self->strwidth ($_), @lines;
624	# for (map $self->strwidth ($_), @lines) {	1152
625	# $w = $_ if $w < $_;
626	# }
627	#
628	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1153	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
629	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1154	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
630	#}	1155
		1156	$overlay
		1157	}
631		1158
632	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1159	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
633		1160
634	Create a new (empty) overlay at the given position with the given	1161	Create a new (empty) overlay at the given position with the given
635	width/height. C<$rstyle> defines the initial rendition style	1162	width/height. C<$rstyle> defines the initial rendition style
…		…
662		1189
663	If hidden, display the overlay again.	1190	If hidden, display the overlay again.
664		1191
665	=back	1192	=back
666		1193
		1194	=item $popup = $term->popup ($event)
		1195
		1196	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1197	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1198	currently).
		1199
		1200	=cut
		1201
		1202	sub popup {
		1203	my ($self, $event) = @_;
		1204
		1205	$self->grab ($event->{time}, 1)
		1206	or return;
		1207
		1208	my $popup = bless {
		1209	term => $self,
		1210	event => $event,
		1211	}, urxvt::popup::;
		1212
		1213	Scalar::Util::weaken $popup->{term};
		1214
		1215	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1216	Scalar::Util::weaken $self->{_destroy}{$popup};
		1217
		1218	$popup
		1219	}
		1220
667	=item $cellwidth = $term->strwidth ($string)	1221	=item $cellwidth = $term->strwidth ($string)
668		1222
669	Returns the number of screen-cells this string would need. Correctly	1223	Returns the number of screen-cells this string would need. Correctly
670	accounts for wide and combining characters.	1224	accounts for wide and combining characters.
671		1225
…		…
674	Convert the given text string into the corresponding locale encoding.	1228	Convert the given text string into the corresponding locale encoding.
675		1229
676	=item $string = $term->locale_decode ($octets)	1230	=item $string = $term->locale_decode ($octets)
677		1231
678	Convert the given locale-encoded octets into a perl string.	1232	Convert the given locale-encoded octets into a perl string.
		1233
		1234	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1235
		1236	XORs the rendition values in the given span with the provided value
		1237	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1238	refresh hooks to provide effects similar to the selection.
		1239
		1240	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1241
		1242	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1243	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1244	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1245	it instead. Both styles I<MUST NOT> contain font styles.
		1246
		1247	=item $term->scr_bell
		1248
		1249	Ring the bell!
679		1250
680	=item $term->scr_add_lines ($string)	1251	=item $term->scr_add_lines ($string)
681		1252
682	Write the given text string to the screen, as if output by the application	1253	Write the given text string to the screen, as if output by the application
683	running inside the terminal. It may not contain command sequences (escape	1254	running inside the terminal. It may not contain command sequences (escape
…		…
698		1269
699	Write the octets given in C<$data> to the tty (i.e. as program input). To	1270	Write the octets given in C<$data> to the tty (i.e. as program input). To
700	pass characters instead of octets, you should convert your strings first	1271	pass characters instead of octets, you should convert your strings first
701	to the locale-specific encoding using C<< $term->locale_encode >>.	1272	to the locale-specific encoding using C<< $term->locale_encode >>.
702		1273
		1274	=item $old_events = $term->pty_ev_events ([$new_events])
		1275
		1276	Replaces the event mask of the pty watcher by the given event mask. Can
		1277	be used to suppress input and output handling to the pty/tty. See the
		1278	description of C<< urxvt::timer->events >>. Make sure to always restore
		1279	the previous value.
		1280
703	=item $windowid = $term->parent	1281	=item $windowid = $term->parent
704		1282
705	Return the window id of the toplevel window.	1283	Return the window id of the toplevel window.
706		1284
707	=item $windowid = $term->vt	1285	=item $windowid = $term->vt
708		1286
709	Return the window id of the terminal window.	1287	Return the window id of the terminal window.
710		1288
		1289	=item $term->vt_emask_add ($x_event_mask)
		1290
		1291	Adds the specified events to the vt event mask. Useful e.g. when you want
		1292	to receive pointer events all the times:
		1293
		1294	$term->vt_emask_add (urxvt::PointerMotionMask);
		1295
711	=item $window_width = $term->width	1296	=item $window_width = $term->width
712		1297
713	=item $window_height = $term->height	1298	=item $window_height = $term->height
714		1299
715	=item $font_width = $term->fwidth	1300	=item $font_width = $term->fwidth
…		…
728		1313
729	=item $max_scrollback = $term->saveLines	1314	=item $max_scrollback = $term->saveLines
730		1315
731	=item $nrow_plus_saveLines = $term->total_rows	1316	=item $nrow_plus_saveLines = $term->total_rows
732		1317
733	=item $lines_in_scrollback = $term->nsaved	1318	=item $topmost_scrollback_row = $term->top_row
734		1319
735	Return various integers describing terminal characteristics.	1320	Return various integers describing terminal characteristics.
736		1321
		1322	=item $x_display = $term->display_id
		1323
		1324	Return the DISPLAY used by rxvt-unicode.
		1325
		1326	=item $lc_ctype = $term->locale
		1327
		1328	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1329
		1330	=item $env = $term->env
		1331
		1332	Returns a copy of the environment in effect for the terminal as a hashref
		1333	similar to C<\%ENV>.
		1334
		1335	=cut
		1336
		1337	sub env {
		1338	if (my $env = $_[0]->_env) {
		1339	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1340	} else {
		1341	+{ %ENV }
		1342	}
		1343	}
		1344
		1345	=item $modifiermask = $term->ModLevel3Mask
		1346
		1347	=item $modifiermask = $term->ModMetaMask
		1348
		1349	=item $modifiermask = $term->ModNumLockMask
		1350
		1351	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1352	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1353
737	=item $view_start = $term->view_start ([$newvalue])	1354	=item $view_start = $term->view_start ([$newvalue])
738		1355
739	Returns the negative row number of the topmost line. Minimum value is	1356	Returns the row number of the topmost displayed line. Maximum value is
740	C<0>, which displays the normal terminal contents. Larger values scroll	1357	C<0>, which displays the normal terminal contents. Lower values scroll
741	this many lines into the scrollback buffer.	1358	this many lines into the scrollback buffer.
742		1359
743	=item $term->want_refresh	1360	=item $term->want_refresh
744		1361
745	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1362	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
824	Return the row number of the first/last row of the line, respectively.	1441	Return the row number of the first/last row of the line, respectively.
825		1442
826	=item $offset = $line->offset_of ($row, $col)	1443	=item $offset = $line->offset_of ($row, $col)
827		1444
828	Returns the character offset of the given row|col pair within the logical	1445	Returns the character offset of the given row|col pair within the logical
829	line.	1446	line. Works for rows outside the line, too, and returns corresponding
		1447	offsets outside the string.
830		1448
831	=item ($row, $col) = $line->coord_of ($offset)	1449	=item ($row, $col) = $line->coord_of ($offset)
832		1450
833	Translates a string offset into terminal coordinates again.	1451	Translates a string offset into terminal coordinates again.
834		1452
835	=back	1453	=back
836		1454
837	=cut	1455	=cut
838		1456
839	sub urxvt::term::line {	1457	sub line {
840	my ($self, $row) = @_;	1458	my ($self, $row) = @_;
841		1459
842	my $maxrow = $self->nrow - 1;	1460	my $maxrow = $self->nrow - 1;
843		1461
844	my ($beg, $end) = ($row, $row);	1462	my ($beg, $end) = ($row, $row);
…		…
908	$offset / $self->{ncol} + $self->{beg},	1526	$offset / $self->{ncol} + $self->{beg},
909	$offset % $self->{ncol}	1527	$offset % $self->{ncol}
910	)	1528	)
911	}	1529	}
912		1530
913	=item ($row, $col) = $line->coord_of ($offset)
914	=item $text = $term->special_encode $string	1531	=item $text = $term->special_encode $string
915		1532
916	Converts a perl string into the special encoding used by rxvt-unicode,	1533	Converts a perl string into the special encoding used by rxvt-unicode,
917	where one character corresponds to one screen cell. See	1534	where one character corresponds to one screen cell. See
918	C<< $term->ROW_t >> for details.	1535	C<< $term->ROW_t >> for details.
…		…
920	=item $string = $term->special_decode $text	1537	=item $string = $term->special_decode $text
921		1538
922	Converts rxvt-unicodes text reprsentation into a perl string. See	1539	Converts rxvt-unicodes text reprsentation into a perl string. See
923	C<< $term->ROW_t >> for details.	1540	C<< $term->ROW_t >> for details.
924		1541
		1542	=item $success = $term->grab_button ($button, $modifiermask)
		1543
		1544	Registers a synchronous button grab. See the XGrabButton manpage.
		1545
		1546	=item $success = $term->grab ($eventtime[, $sync])
		1547
		1548	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1549	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1550
		1551	=item $term->allow_events_async
		1552
		1553	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1554
		1555	=item $term->allow_events_sync
		1556
		1557	Calls XAllowEvents with SyncBoth for the most recent grab.
		1558
		1559	=item $term->allow_events_replay
		1560
		1561	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1562	recent grab.
		1563
		1564	=item $term->ungrab
		1565
		1566	Calls XUngrab for the most recent grab. Is called automatically on
		1567	evaluation errors, as it is better to lose the grab in the error case as
		1568	the session.
		1569
925	=back	1570	=back
		1571
		1572	=cut
		1573
		1574	package urxvt::popup;
		1575
		1576	=head2 The C<urxvt::popup> Class
		1577
		1578	=over 4
		1579
		1580	=cut
		1581
		1582	sub add_item {
		1583	my ($self, $item) = @_;
		1584
		1585	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1586	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1587	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1588
		1589	$item->{render} ||= sub { $_[0]{text} };
		1590
		1591	push @{ $self->{item} }, $item;
		1592	}
		1593
		1594	=item $popup->add_title ($title)
		1595
		1596	Adds a non-clickable title to the popup.
		1597
		1598	=cut
		1599
		1600	sub add_title {
		1601	my ($self, $title) = @_;
		1602
		1603	$self->add_item ({
		1604	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1605	text => $title,
		1606	activate => sub { },
		1607	});
		1608	}
		1609
		1610	=item $popup->add_separator ([$sepchr])
		1611
		1612	Creates a separator, optionally using the character given as C<$sepchr>.
		1613
		1614	=cut
		1615
		1616	sub add_separator {
		1617	my ($self, $sep) = @_;
		1618
		1619	$sep ||= "=";
		1620
		1621	$self->add_item ({
		1622	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1623	text => "",
		1624	render => sub { $sep x $self->{term}->ncol },
		1625	activate => sub { },
		1626	});
		1627	}
		1628
		1629	=item $popup->add_button ($text, $cb)
		1630
		1631	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1632	selected.
		1633
		1634	=cut
		1635
		1636	sub add_button {
		1637	my ($self, $text, $cb) = @_;
		1638
		1639	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1640	}
		1641
		1642	=item $popup->add_toggle ($text, $cb, $initial_value)
		1643
		1644	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1645	whenever it gets toggled, with a boolean indicating its value as its first
		1646	argument.
		1647
		1648	=cut
		1649
		1650	sub add_toggle {
		1651	my ($self, $text, $cb, $value) = @_;
		1652
		1653	my $item; $item = {
		1654	type => "button",
		1655	text => " $text",
		1656	value => $value,
		1657	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1658	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1659	};
		1660
		1661	$self->add_item ($item);
		1662	}
		1663
		1664	=item $popup->show
		1665
		1666	Displays the popup (which is initially hidden).
		1667
		1668	=cut
		1669
		1670	sub show {
		1671	my ($self) = @_;
		1672
		1673	local $urxvt::popup::self = $self;
		1674
		1675	my $env = $self->{term}->env;
		1676	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1677	delete $env->{LC_ALL};
		1678	$env->{LC_CTYPE} = $self->{term}->locale;
		1679
		1680	urxvt::term->new ($env, "popup",
		1681	"--perl-lib" => "", "--perl-ext-common" => "",
		1682	"-pty-fd" => -1, "-sl" => 0,
		1683	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		1684	"--transient-for" => $self->{term}->parent,
		1685	"-display" => $self->{term}->display_id,
		1686	"-pe" => "urxvt-popup")
		1687	or die "unable to create popup window\n";
		1688	}
		1689
		1690	sub DESTROY {
		1691	my ($self) = @_;
		1692
		1693	delete $self->{term}{_destroy}{$self};
		1694	$self->{term}->ungrab;
		1695	}
		1696
		1697	=back
		1698
		1699	=cut
		1700
		1701	package urxvt::watcher;
		1702
		1703	@urxvt::timer::ISA = __PACKAGE__;
		1704	@urxvt::iow::ISA = __PACKAGE__;
		1705	@urxvt::pw::ISA = __PACKAGE__;
		1706	@urxvt::iw::ISA = __PACKAGE__;
926		1707
927	=head2 The C<urxvt::timer> Class	1708	=head2 The C<urxvt::timer> Class
928		1709
929	This class implements timer watchers/events. Time is represented as a	1710	This class implements timer watchers/events. Time is represented as a
930	fractional number of seconds since the epoch. Example:	1711	fractional number of seconds since the epoch. Example:
…		…
969		1750
970	=item $timer = $timer->start ($tstamp)	1751	=item $timer = $timer->start ($tstamp)
971		1752
972	Set the event trigger time to C<$tstamp> and start the timer.	1753	Set the event trigger time to C<$tstamp> and start the timer.
973		1754
		1755	=item $timer = $timer->after ($delay)
		1756
		1757	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1758
974	=item $timer = $timer->stop	1759	=item $timer = $timer->stop
975		1760
976	Stop the timer.	1761	Stop the timer.
977		1762
978	=back	1763	=back
…		…
983		1768
984	$term->{socket} = ...	1769	$term->{socket} = ...
985	$term->{iow} = urxvt::iow	1770	$term->{iow} = urxvt::iow
986	->new	1771	->new
987	->fd (fileno $term->{socket})	1772	->fd (fileno $term->{socket})
988	->events (1) # wait for read data	1773	->events (urxvt::EVENT_READ)
989	->start	1774	->start
990	->cb (sub {	1775	->cb (sub {
991	my ($iow, $revents) = @_;	1776	my ($iow, $revents) = @_;
992	# $revents must be 1 here, no need to check	1777	# $revents must be 1 here, no need to check
993	sysread $term->{socket}, my $buf, 8192	1778	sysread $term->{socket}, my $buf, 8192
…		…
1010		1795
1011	Set the filedescriptor (not handle) to watch.	1796	Set the filedescriptor (not handle) to watch.
1012		1797
1013	=item $iow = $iow->events ($eventmask)	1798	=item $iow = $iow->events ($eventmask)
1014		1799
1015	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1800	Set the event mask to watch. The only allowed values are
1016	data, Bit #1 (value C<2>) enables watching for write data.	1801	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1802	together, or C<urxvt::EVENT_NONE>.
1017		1803
1018	=item $iow = $iow->start	1804	=item $iow = $iow->start
1019		1805
1020	Start watching for requested events on the given handle.	1806	Start watching for requested events on the given handle.
1021		1807
1022	=item $iow = $iow->stop	1808	=item $iow = $iow->stop
1023		1809
1024	Stop watching for events on the given filehandle.	1810	Stop watching for events on the given filehandle.
		1811
		1812	=back
		1813
		1814	=head2 The C<urxvt::iw> Class
		1815
		1816	This class implements idle watchers, that get called automatically when
		1817	the process is idle. They should return as fast as possible, after doing
		1818	some useful work.
		1819
		1820	=over 4
		1821
		1822	=item $iw = new urxvt::iw
		1823
		1824	Create a new idle watcher object in stopped state.
		1825
		1826	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1827
		1828	Set the callback to be called when the watcher triggers.
		1829
		1830	=item $timer = $timer->start
		1831
		1832	Start the watcher.
		1833
		1834	=item $timer = $timer->stop
		1835
		1836	Stop the watcher.
		1837
		1838	=back
		1839
		1840	=head2 The C<urxvt::pw> Class
		1841
		1842	This class implements process watchers. They create an event whenever a
		1843	process exits, after which they stop automatically.
		1844
		1845	my $pid = fork;
		1846	...
		1847	$term->{pw} = urxvt::pw
		1848	->new
		1849	->start ($pid)
		1850	->cb (sub {
		1851	my ($pw, $exit_status) = @_;
		1852	...
		1853	});
		1854
		1855	=over 4
		1856
		1857	=item $pw = new urxvt::pw
		1858
		1859	Create a new process watcher in stopped state.
		1860
		1861	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1862
		1863	Set the callback to be called when the timer triggers.
		1864
		1865	=item $pw = $timer->start ($pid)
		1866
		1867	Tells the wqtcher to start watching for process C<$pid>.
		1868
		1869	=item $pw = $pw->stop
		1870
		1871	Stop the watcher.
1025		1872
1026	=back	1873	=back
1027		1874
1028	=head1 ENVIRONMENT	1875	=head1 ENVIRONMENT
1029		1876
…		…
1032	This variable controls the verbosity level of the perl extension. Higher	1879	This variable controls the verbosity level of the perl extension. Higher
1033	numbers indicate more verbose output.	1880	numbers indicate more verbose output.
1034		1881
1035	=over 4	1882	=over 4
1036		1883
1037	=item =0 - only fatal messages	1884	=item == 0 - fatal messages
1038		1885
1039	=item =3 - script loading and management	1886	=item >= 3 - script loading and management
1040		1887
1041	=item =10 - all events received	1888	=item >=10 - all called hooks
		1889
		1890	=item >=11 - hook reutrn values
1042		1891
1043	=back	1892	=back
1044		1893
1045	=head1 AUTHOR	1894	=head1 AUTHOR
1046		1895

Diff Legend

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