ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

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

Diff Legend

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