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.65 by root, Mon Jan 9 19:25:57 2006 UTC vs.
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC

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

Diff Legend

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