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

Diff Legend

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