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.206 by root, Tue Jun 5 21:06:15 2012 UTC vs.
Revision 1.265 by root, Sat Jul 24 09:48:43 2021 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in some directory:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt instance using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib path/to/somedirectory -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Every time a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, 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	You can disable the embedded perl interpreter by setting both "perl-ext"	31	You can disable the embedded perl interpreter by setting both "perl-ext"
32	and "perl-ext-common" resources to the empty string.	32	and "perl-ext-common" resources to the empty string.
33		33
34	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
35		35
36	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
38		39
39	You can activate them like this:	40	You can activate them like this:
40		41
41	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
42		43
43	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
44		45
45	URxvt.perl-ext-common: default,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
46		47
47	=over 4	48	Extensions may add additional resources and C<actions>, i.e., methods
48		49	which can be bound to a key and invoked by the user. An extension can
49	=item selection (enabled by default)	50	define the resources it support using so called META comments,
50		51	described below. Similarly to builtin resources, extension resources
51	(More) intelligent selection. This extension tries to be more intelligent	52	can also be specified on the command line as long options (with C<.>
52	when the user extends selections (double-click and further clicks). Right	53	replaced by C<->), in which case the corresponding extension is loaded
53	now, it tries to select words, urls and complete shell-quoted	54	automatically. For this to work the extension B<must> define META
54	arguments, which is very convenient, too, if your F<ls> supports	55	comments for its resources.
55	C<--quoting-style=shell>.
56
57	A double-click usually selects the word under the cursor, further clicks
58	will enlarge the selection.
59
60	The selection works by trying to match a number of regexes and displaying
61	them in increasing order of length. You can add your own regexes by
62	specifying resources of the form:
63
64	URxvt.selection.pattern-0: perl-regex
65	URxvt.selection.pattern-1: perl-regex
66	...
67
68	The index number (0, 1...) must not have any holes, and each regex must
69	contain at least one pair of capturing parentheses, which will be used for
70	the match. For example, the following adds a regex that matches everything
71	between two vertical bars:
72
73	URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75	Another example: Programs I use often output "absolute path: " at the
76	beginning of a line when they process multiple files. The following
77	pattern matches the filename (note, there is a single space at the very
78	end):
79
80	URxvt.selection.pattern-0: ^(/[^:]+):\
81
82	You can look at the source of the selection extension to see more
83	interesting uses, such as parsing a line from beginning to end.
84
85	This extension also offers following bindable keyboard commands:
86
87	=over 4
88
89	=item rot13
90
91	Rot-13 the selection when activated. Used via keyboard trigger:
92
93	URxvt.keysym.C-M-r: perl:selection:rot13
94
95	=back
96
97	=item option-popup (enabled by default)
98
99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
100	runtime.
101
102	Other extensions can extend this popup menu by pushing a code reference
103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104	popup is being displayed.
105
106	Its sole argument is the popup menu, which can be modified. It should
107	either return nothing or a string, the initial boolean value and a code
108	reference. The string will be used as button text and the code reference
109	will be called when the toggle changes, with the new boolean value as
110	first argument.
111
112	The following will add an entry C<myoption> that changes
113	C<< $self->{myoption} >>:
114
115	push @{ $self->{term}{option_popup_hook} }, sub {
116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117	};
118
119	=item selection-popup (enabled by default)
120
121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122	text into various other formats/action (such as uri unescaping, perl
123	evaluation, web-browser starting etc.), depending on content.
124
125	Other extensions can extend this popup menu by pushing a code reference
126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127	popup is being displayed.
128
129	Its sole argument is the popup menu, which can be modified. The selection
130	is in C<$_>, which can be used to decide whether to add something or not.
131	It should either return nothing or a string and a code reference. The
132	string will be used as button text and the code reference will be called
133	when the button gets activated and should transform C<$_>.
134
135	The following will add an entry C<a to b> that transforms all C<a>s in
136	the selection to C<b>s, but only if the selection currently contains any
137	C<a>s:
138
139	push @{ $self->{term}{selection_popup_hook} }, sub {
140	/a/ ? ("a to b" => sub { s/a/b/g }
141	: ()
142	};
143
144	=item searchable-scrollback<hotkey> (enabled by default)
145
146	Adds regex search functionality to the scrollback buffer, triggered
147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
148	input/output is suspended and a regex is displayed at the bottom of the
149	screen.
150
151	Inputting characters appends them to the regex and continues incremental
152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
154	bottom. C<Escape> leaves search mode and returns to the point where search
155	was started, while C<Enter> or C<Return> stay at the current position and
156	additionally stores the first match in the current line into the primary
157	selection if the C<Shift> modifier is active.
158
159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
160	get a case-sensitive search you can delete this prefix using C<BackSpace>
161	or simply use an uppercase character which removes the "(?i)" prefix.
162
163	See L<perlre> for more info about perl regular expression syntax.
164
165	=item readline (enabled by default)
166
167	A support package that tries to make editing with readline easier. At
168	the moment, it reacts to clicking shift-left mouse button by trying to
169	move the text cursor to this position. It does so by generating as many
170	cursor-left or cursor-right keypresses as required (this only works
171	for programs that correctly support wide characters).
172
173	To avoid too many false positives, this is only done when:
174
175	=over 4
176
177	=item - the tty is in ICANON state.
178
179	=item - the text cursor is visible.
180
181	=item - the primary screen is currently being displayed.
182
183	=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185	=back
186
187	The normal selection mechanism isn't disabled, so quick successive clicks
188	might interfere with selection creation in harmless ways.
189
190	=item selection-autotransform
191
192	This selection allows you to do automatic transforms on a selection
193	whenever a selection is made.
194
195	It works by specifying perl snippets (most useful is a single C<s///>
196	operator) that modify C<$_> as resources:
197
198	URxvt.selection-autotransform.0: transform
199	URxvt.selection-autotransform.1: transform
200	...
201
202	For example, the following will transform selections of the form
203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
204	$word>:
205
206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208	And this example matches the same,but replaces it with vi-commands you can
209	paste directly into your (vi :) editor:
210
211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213	Of course, this can be modified to suit your needs and your editor :)
214
215	To expand the example above to typical perl error messages ("XXX at
216	FILENAME line YYY."), you need a slightly more elaborate solution:
217
218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221	The first line tells the selection code to treat the unchanging part of
222	every error message as a selection pattern, and the second line transforms
223	the message into vi commands to load the file.
224
225	=item tabbed
226
227	This transforms the terminal into a tabbar with additional terminals, that
228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230	button per tab.
231
232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
233	B<Shift-Right> will switch to the tab left or right of the current one,
234	while B<Shift-Down> creates a new tab.
235
236	The tabbar itself can be configured similarly to a normal terminal, but
237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
238	following four resources (shown with defaults):
239
240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242	URxvt.tabbed.tab-fg: <colour-index, default 0>
243	URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246	indices.
247
248	=item matcher
249
250	Uses per-line display filtering (C<on_line_update>) to underline text
251	matching a certain pattern and make it clickable. When clicked with the
252	mouse button specified in the C<matcher.button> resource (default 2, or
253	middle), the program specified in the C<matcher.launcher> resource
254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255	with the matched text as first argument. The default configuration is
256	suitable for matching URLs and launching a web browser, like the
257	former "mark-urls" extension.
258
259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.
263
264	It is possible to activate the most recently seen match or a list of matches
265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266	"perl:matcher:list" as seen in the example below.
267
268	Example configuration:
269
270	URxvt.perl-ext: default,matcher
271	URxvt.urlLauncher: sensible-browser
272	URxvt.keysym.C-Delete: perl:matcher:last
273	URxvt.keysym.M-Delete: perl:matcher:list
274	URxvt.matcher.button: 1
275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
277	URxvt.matcher.launcher.2: gvim +$2 $1
278
279	=item xim-onthespot
280
281	This (experimental) perl extension implements OnTheSpot editing. It does
282	not work perfectly, and some input methods don't seem to work well with
283	OnTheSpot editing in general, but it seems to work at least for SCIM and
284	kinput2.
285
286	You enable it by specifying this extension and a preedit style of
287	C<OnTheSpot>, i.e.:
288
289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
290
291	=item kuake<hotkey>
292
293	A very primitive quake-console-like extension. It was inspired by a
294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
295	user presses a global accelerator key (by default C<F10>), the terminal
296	will show or hide itself. Another press of the accelerator key will hide
297	or show it again.
298
299	Initially, the window will not be shown when using this extension.
300
301	This is useful if you need a single terminal that is not using any desktop
302	space most of the time but is quickly available at the press of a key.
303
304	The accelerator key is grabbed regardless of any modifiers, so this
305	extension will actually grab a physical key just for this function.
306
307	If you want a quake-like animation, tell your window manager to do so
308	(fvwm can do it).
309
310	=item overlay-osc
311
312	This extension implements some OSC commands to display timed popups on the
313	screen - useful for status displays from within scripts. You have to read
314	the sources for more info.
315
316	=item block-graphics-to-ascii
317
318	A not very useful example of filtering all text output to the terminal
319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
320	similar-looking ascii character.
321
322	=item digital-clock
323
324	Displays a digital clock using the built-in overlay.
325
326	=item remote-clipboard
327
328	Somewhat of a misnomer, this extension adds two menu entries to the
329	selection popup that allows one to run external commands to store the
330	selection somewhere and fetch it again.
331
332	We use it to implement a "distributed selection mechanism", which just
333	means that one command uploads the file to a remote server, and another
334	reads it.
335
336	The commands can be set using the C<URxvt.remote-selection.store> and
337	C<URxvt.remote-selection.fetch> resources. The first should read the
338	selection to store from STDIN (always in UTF-8), the second should provide
339	the selection data on STDOUT (also in UTF-8).
340
341	The defaults (which are likely useless to you) use rsh and cat:
342
343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
345
346	=item selection-pastebin
347
348	This is a little rarely useful extension that uploads the selection as
349	textfile to a remote site (or does other things). (The implementation is
350	not currently secure for use in a multiuser environment as it writes to
351	F</tmp> directly.).
352
353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
354	i.e.
355
356	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
357
358	Pressing this combination runs a command with C<%> replaced by the name of
359	the textfile. This command can be set via a resource:
360
361	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
362
363	And the default is likely not useful to anybody but the few people around
364	here :)
365
366	The name of the textfile is the hex encoded md5 sum of the selection, so
367	the same content should lead to the same filename.
368
369	After a successful upload the selection will be replaced by the text given
370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
371	for the filename):
372
373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
374
375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
376	the double C</> characters as comment start. Use C<\057\057> instead,
377	which works regardless of whether xrdb is used to parse the resource file
378	or not.
379
380	=item macosx-clipboard and macosx-clipboard-native
381
382	These two modules implement an extended clipboard for Mac OS X. They are
383	used like this:
384
385	URxvt.perl-ext-common: default,macosx-clipboard
386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389	The difference between them is that the native variant requires a
390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392	simpler etc. etc.
393
394	=item example-refresh-hooks
395
396	Displays a very simple digital clock in the upper right corner of the
397	window. Illustrates overwriting the refresh callbacks to create your own
398	overlays or changes.
399
400	=item confirm-paste
401
402	Displays a confirmation dialog when a paste containing at least a full
403	line is detected.
404
405	=item bell-command
406
407	Runs the command specified by the C<URxvt.bell-command> resource when
408	a bell event occurs. For example, the following pops up a notification
409	bubble with the text "Beep, Beep" using notify-send:
410
411	URxvt.bell-command: notify-send "Beep, Beep"
412
413	=back
414		56
415	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
416		58
417	=head2 General API Considerations	59	=head2 General API Considerations
418		60
…		…
428	terminal is destroyed.	70	terminal is destroyed.
429		71
430	Argument names also often indicate the type of a parameter. Here are some	72	Argument names also often indicate the type of a parameter. Here are some
431	hints on what they mean:	73	hints on what they mean:
432		74
433	=over 4	75	=over
434		76
435	=item $text	77	=item $text
436		78
437	Rxvt-unicode's special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
438	always represents one screen cell. See L<ROW_t> for a discussion of this format.	80	always represents one screen cell. See L<ROW_t> for a discussion of this format.
…		…
467	internal use.	109	internal use.
468		110
469	Although it isn't a C<urxvt::term> object, you can call all methods of the	111	Although it isn't a C<urxvt::term> object, you can call all methods of the
470	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
471		113
472	It has the following methods and data members:	114	Additional methods only supported for extension objects are described in
		115	the C<urxvt::extension> section below.
473		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata. These comments are scanned whenever a
		121	terminal is created and are typically used to autoload extensions when
		122	their resources or command line parameters are used.
		123
		124	Currently, it recognises only one such comment:
		125
474	=over 4	126	=over
475		127
476	=item $urxvt_term = $self->{term}	128	=item #:META:RESOURCE:name:type:desc
477		129
478	Returns the C<urxvt::term> object associated with this instance of the	130	The RESOURCE comment defines a resource used by the extension, where
479	extension. This member I<must not> be changed in any way.	131	C<name> is the resource name, C<type> is the resource type, C<boolean>
		132	or C<string>, and C<desc> is the resource description.
480		133
481	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	134	The extension will be autoloaded when this resource is specified or used
482		135	as a command line parameter.
483	Dynamically enable the given hooks (named without the C<on_> prefix) for
484	this extension, replacing any previous hook. This is useful when you want
485	to overwrite time-critical hooks only temporarily.
486
487	=item $self->disable ($hook_name[, $hook_name..])
488
489	Dynamically disable the given hooks.
490		136
491	=back	137	=back
492		138
493	=head2 Hooks	139	=head2 Hooks
494		140
…		…
502	hooks returns true, then the event counts as being I<consumed>, and the	148	hooks returns true, then the event counts as being I<consumed>, and the
503	relevant action might not be carried out by the C++ code.	149	relevant action might not be carried out by the C++ code.
504		150
505	I<< When in doubt, return a false value (preferably C<()>). >>	151	I<< When in doubt, return a false value (preferably C<()>). >>
506		152
507	=over 4	153	=over
508		154
509	=item on_init $term	155	=item on_init $term
510		156
511	Called after a new terminal object has been initialized, but before	157	Called after a new terminal object has been initialized, but before
512	windows are created or the command gets run. Most methods are unsafe to	158	windows are created or the command gets run. Most methods are unsafe to
…		…
663		309
664	=item on_refresh_end $term	310	=item on_refresh_end $term
665		311
666	Called just after the screen gets redrawn. See C<on_refresh_begin>.	312	Called just after the screen gets redrawn. See C<on_refresh_begin>.
667		313
		314	=item on_action $term, $string
		315
		316	Called whenever an action is invoked for the corresponding extension
		317	(e.g. via a C<extension:string> builtin action bound to a key, see
		318	description of the B<keysym> resource in the urxvt(1) manpage). The
		319	event is simply the action string. Note that an action event is always
		320	associated to a single extension.
		321
668	=item on_user_command $term, $string	322	=item on_user_command $term, $string *DEPRECATED*
669		323
670	Called whenever a user-configured event is being activated (e.g. via	324	Called whenever a user-configured event is being activated (e.g. via
671	a C<perl:string> action bound to a key, see description of the B<keysym>	325	a C<perl:string> action bound to a key, see description of the B<keysym>
672	resource in the @@RXVT_NAME@@(1) manpage).	326	resource in the urxvt(1) manpage).
673		327
674	The event is simply the action string. This interface is assumed to change	328	The event is simply the action string. This interface is going away in
675	slightly in the future.	329	preference to the C<on_action> hook.
676
677	=item on_register_command $term, $keysym, $modifiermask, $string
678
679	Called after parsing a keysym resource but before registering the
680	associated binding. If this hook returns TRUE the binding is not
681	registered. It can be used to modify a binding by calling
682	C<register_command>.
683		330
684	=item on_resize_all_windows $term, $new_width, $new_height	331	=item on_resize_all_windows $term, $new_width, $new_height
685		332
686	Called just after the new window size has been calculated, but before	333	Called just after the new window size has been calculated, but before
687	windows are actually being resized or hints are being set. If this hook	334	windows are actually being resized or hints are being set. If this hook
688	returns TRUE, setting of the window hints is being skipped.	335	returns a true value, setting of the window hints is being skipped.
689		336
690	=item on_x_event $term, $event	337	=item on_x_event $term, $event
691		338
692	Called on every X event received on the vt window (and possibly other	339	Called on every X event received on the vt window (and possibly other
693	windows). Should only be used as a last resort. Most event structure	340	windows). Should only be used as a last resort. Most event structure
…		…
733	(real, not screen-based) row and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
734		381
735	C<on_key_press> additionally receives the string rxvt-unicode would	382	C<on_key_press> additionally receives the string rxvt-unicode would
736	output, if any, in locale-specific encoding.	383	output, if any, in locale-specific encoding.
737		384
738	subwindow.
739
740	=item on_client_message $term, $event	385	=item on_client_message $term, $event
741		386
742	=item on_wm_protocols $term, $event	387	=item on_wm_protocols $term, $event
743		388
744	=item on_wm_delete_window $term, $event	389	=item on_wm_delete_window $term, $event
…		…
755	=cut	400	=cut
756		401
757	package urxvt;	402	package urxvt;
758		403
759	use utf8;	404	use utf8;
760	use strict;	405	use strict 'vars';
761	use Carp ();	406	use Carp ();
762	use Scalar::Util ();	407	use Scalar::Util ();
763	use List::Util ();	408	use List::Util ();
764		409
765	our $VERSION = 1;	410	our $VERSION = 1;
766	our $TERM;	411	our $TERM;
767	our @TERM_INIT;	412	our @TERM_INIT; # should go, prevents async I/O etc.
768	our @TERM_EXT;	413	our @TERM_EXT; # should go, prevents async I/O etc.
769	our @HOOKNAME;	414	our @HOOKNAME;
770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
771	our %OPTION;	416	our %OPTION;
772		417
773	our $LIBDIR;	418	our $LIBDIR;
…		…
777		422
778	our $NOCHAR = chr 0xffff;	423	our $NOCHAR = chr 0xffff;
779		424
780	=head2 Variables in the C<urxvt> Package	425	=head2 Variables in the C<urxvt> Package
781		426
782	=over 4	427	=over
783		428
784	=item $urxvt::LIBDIR	429	=item $urxvt::LIBDIR
785		430
786	The rxvt-unicode library directory, where, among other things, the perl	431	The rxvt-unicode library directory, where, among other things, the perl
787	modules and scripts are stored.	432	modules and scripts are stored.
…		…
817		462
818	=back	463	=back
819		464
820	=head2 Functions in the C<urxvt> Package	465	=head2 Functions in the C<urxvt> Package
821		466
822	=over 4	467	=over
823		468
824	=item urxvt::fatal $errormessage	469	=item urxvt::fatal $errormessage
825		470
826	Fatally aborts execution with the given error message (which should	471	Fatally aborts execution with the given error message (which should
827	include a trailing newline). Avoid at all costs! The only time this	472	include a trailing newline). Avoid at all costs! The only time this
…		…
872	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
873	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
874		519
875	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
876		521
		522	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		523	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		524	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		525	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		526	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		527	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		528	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
		529	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		530	PrivMode_Default
		531
		532	Constants for checking DEC private modes.
		533
877	=back	534	=back
878		535
879	=head2 RENDITION	536	=head2 RENDITION
880		537
881	Rendition bitsets contain information about colour, font, font styles and	538	Rendition bitsets contain information about colour, font, font styles and
…		…
884	The following "macros" deal with changes in rendition sets. You should	541	The following "macros" deal with changes in rendition sets. You should
885	never just create a bitset, you should always modify an existing one,	542	never just create a bitset, you should always modify an existing one,
886	as they contain important information required for correct operation of	543	as they contain important information required for correct operation of
887	rxvt-unicode.	544	rxvt-unicode.
888		545
889	=over 4	546	=over
890		547
891	=item $rend = urxvt::DEFAULT_RSTYLE	548	=item $rend = urxvt::DEFAULT_RSTYLE
892		549
893	Returns the default rendition, as used when the terminal is starting up or	550	Returns the default rendition, as used when the terminal is starting up or
894	being reset. Useful as a base to start when creating renditions.	551	being reset. Useful as a base to start when creating renditions.
…		…
943	};	600	};
944	}	601	}
945		602
946	no warnings 'utf8';	603	no warnings 'utf8';
947		604
948	sub resource {	605	sub parse_resource {
949	my ($term, $name, $isarg, $flag, $value) = @_;	606	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
950		607
951	warn "resourece<@_>\n";#d#	608	$term->scan_extensions;
		609
		610	# iterating over all resources has quadratic time overhead
		611	# overall, maybe this could be optimised?
		612	my $r = $term->{meta}{resource};
		613	keys %$r; # reset iterator
		614	while (my ($k, $v) = each %$r) {
		615	my $pattern = $k;
		616	$pattern =~ y/./-/ if $isarg;
		617	my $prefix = $name;
		618	my $suffix;
		619	if ($pattern =~ /\-$/) {
		620	$prefix = substr $name, 0, length $pattern;
		621	$suffix = substr $name, length $pattern;
		622	}
		623	if ($pattern eq $prefix) {
		624	$name = "$urxvt::RESCLASS.$k$suffix";
		625
		626	push @{ $term->{perl_ext_3} }, $v->[0];
		627
		628	return 1 unless $isarg;
		629
		630	if ($v->[1] eq "boolean") {
		631	$term->put_option_db ($name, $flag ? "true" : "false");
		632	return 1;
		633	} else {
		634	$term->put_option_db ($name, $value);
		635	return 1 + 2;
		636	}
		637	}
		638	}
952		639
953	0	640	0
		641	}
		642
		643	sub usage {
		644	my ($term, $usage_type) = @_;
		645
		646	$term->scan_extensions;
		647
		648	my $r = $term->{meta}{resource};
		649
		650	for my $pattern (sort keys %$r) {
		651	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		652
		653	$desc .= " (-pe $ext)";
		654
		655	if ($usage_type == 1) {
		656	$pattern =~ y/./-/;
		657	$pattern =~ s/-$/-.../g;
		658
		659	if ($type eq "boolean") {
		660	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		661	} else {
		662	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		663	}
		664	} else {
		665	$pattern =~ s/\.$/.*/g;
		666	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		667	}
		668	}
954	}	669	}
955		670
956	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	671	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
957		672
958	sub verbose {	673	sub verbose {
…		…
972	$pkg =~ s/[^[:word:]]/_/g;	687	$pkg =~ s/[^[:word:]]/_/g;
973	$pkg = "urxvt::ext::$pkg";	688	$pkg = "urxvt::ext::$pkg";
974		689
975	verbose 3, "loading extension '$path' into package '$pkg'";	690	verbose 3, "loading extension '$path' into package '$pkg'";
976		691
		692	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		693
977	open my $fh, "<:raw", $path	694	open my $fh, "<:raw", $path
978	or die "$path: $!";	695	or die "$path: $!";
979		696
980	my $source =	697	my $source =
981	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	698	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
982	. "#line 1 \"$path\"\n{\n"	699	. "#line 1 \"$path\"\n{\n"
983	. (do { local $/; <$fh> })	700	. (do { local $/; <$fh> })
984	. "\n};\n1";	701	. "\n};\n1";
985		702
986	eval $source	703	eval $source
…		…
995	# called by the rxvt core	712	# called by the rxvt core
996	sub invoke {	713	sub invoke {
997	local $TERM = shift;	714	local $TERM = shift;
998	my $htype = shift;	715	my $htype = shift;
999		716
1000	if ($htype == 0) { # INIT	717	if ($htype == HOOK_INIT) {
1001	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");	718	my @dirs = $TERM->perl_libdirs;
		719
		720	$TERM->scan_extensions;
1002		721
1003	my %ext_arg;	722	my %ext_arg;
1004		723
1005	{	724	{
1006	my @init = @TERM_INIT;	725	my @init = @TERM_INIT;
…		…
1009	my @pkg = @TERM_EXT;	728	my @pkg = @TERM_EXT;
1010	@TERM_EXT = ();	729	@TERM_EXT = ();
1011	$TERM->register_package ($_) for @pkg;	730	$TERM->register_package ($_) for @pkg;
1012	}	731	}
1013		732
		733	for (
		734	@{ delete $TERM->{perl_ext_3} },
1014	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	735	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		736	) {
1015	if ($_ eq "default") {	737	if ($_ eq "default") {
		738
		739	$ext_arg{$_} = []
1016	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	740	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
		741
		742	for ($TERM->_keysym_resources) {
		743	next if /^(?:string|command|builtin|builtin-string|perl)/;
		744	next unless /^([A-Za-z0-9_\-]+):/;
		745
		746	my $ext = $1;
		747
		748	$ext_arg{$ext} = [];
		749	}
		750
1017	} elsif (/^-(.*)$/) {	751	} elsif (/^-(.*)$/) {
1018	delete $ext_arg{$1};	752	delete $ext_arg{$1};
		753
1019	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
1020	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
		756
1021	} else {	757	} else {
1022	$ext_arg{$_} ||= [];	758	$ext_arg{$_} ||= [];
1023	}	759	}
1024	}	760	}
1025		761
…		…
1041		777
1042	if (my $cb = $TERM->{_hook}[$htype]) {	778	if (my $cb = $TERM->{_hook}[$htype]) {
1043	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	779	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1044	if $verbosity >= 10;	780	if $verbosity >= 10;
1045		781
		782	if ($htype == HOOK_ACTION) {
		783	# this hook is only sent to the extension with the name
		784	# matching the first arg
		785	my $pkg = shift;
		786	$pkg =~ y/-/_/;
		787	$pkg = "urxvt::ext::$pkg";
		788
		789	$cb = $cb->{$pkg}
		790	or return undef; #TODO: maybe warn user?
		791
		792	$cb = { $pkg => $cb };
		793	}
		794
1046	for my $pkg (keys %$cb) {	795	for my $pkg (keys %$cb) {
1047	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	796	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
1048	$retval ||= $retval_;	797	$retval ||= $retval_;
1049		798
1050	if ($@) {	799	if ($@) {
1051	$TERM->ungrab; # better to lose the grab than the session	800	$TERM->ungrab; # better to lose the grab than the session
1052	warn $@;	801	warn $@;
…		…
1055		804
1056	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	805	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1057	if $verbosity >= 11;	806	if $verbosity >= 11;
1058	}	807	}
1059		808
1060	if ($htype == 1) { # DESTROY	809	if ($htype == HOOK_DESTROY) {
1061	# clear package objects	810	# clear package objects
1062	%$_ = () for values %{ $TERM->{_pkg} };	811	%$_ = () for values %{ $TERM->{_pkg} };
1063		812
1064	# clear package	813	# clear package
1065	%$TERM = ();	814	%$TERM = ();
…		…
1095	}	844	}
1096	}	845	}
1097	($mask, @color{qw(fg bg)}, \@failed)	846	($mask, @color{qw(fg bg)}, \@failed)
1098	}	847	}
1099		848
1100	# urxvt::term::extension
1101
1102	package urxvt::term::extension;	849	package urxvt::term::extension;
1103		850
1104	sub enable {	851	=head2 The C<urxvt::term::extension> class
1105	my ($self, %hook) = @_;
1106	my $pkg = $self->{_pkg};
1107		852
1108	while (my ($name, $cb) = each %hook) {	853	Each extension attached to a terminal object is represented by
1109	my $htype = $HOOKTYPE{uc $name};	854	a C<urxvt::term::extension> object.
1110	defined $htype
1111	or Carp::croak "unsupported hook type '$name'";
1112		855
1113	$self->set_should_invoke ($htype, +1)	856	You can use these objects, which are passed to all callbacks to store any
1114	unless exists $self->{term}{_hook}[$htype]{$pkg};	857	state related to the terminal and extension instance.
1115		858
1116	$self->{term}{_hook}[$htype]{$pkg} = $cb;	859	The methods (And data members) documented below can be called on extension
1117	}	860	objects, in addition to call methods documented for the <urxvt::term>
1118	}	861	class.
1119		862
1120	sub disable {	863	=over
1121	my ($self, @hook) = @_;
1122	my $pkg = $self->{_pkg};
1123		864
1124	for my $name (@hook) {	865	=item $urxvt_term = $self->{term}
1125	my $htype = $HOOKTYPE{uc $name};
1126	defined $htype
1127	or Carp::croak "unsupported hook type '$name'";
1128		866
1129	$self->set_should_invoke ($htype, -1)	867	Returns the C<urxvt::term> object associated with this instance of the
1130	if delete $self->{term}{_hook}[$htype]{$pkg};	868	extension. This member I<must not> be changed in any way.
1131	}	869
1132	}	870	=cut
1133		871
1134	our $AUTOLOAD;	872	our $AUTOLOAD;
1135		873
1136	sub AUTOLOAD {	874	sub AUTOLOAD {
1137	$AUTOLOAD =~ /:([^:]+)$/	875	$AUTOLOAD =~ /:([^:]+)$/
…		…
1150		888
1151	sub DESTROY {	889	sub DESTROY {
1152	# nop	890	# nop
1153	}	891	}
1154		892
1155	# urxvt::destroy_hook	893	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1156		894
1157	sub urxvt::destroy_hook::DESTROY {	895	sub urxvt::destroy_hook::DESTROY {
1158	${$_[0]}->();	896	${$_[0]}->();
1159	}	897	}
1160		898
1161	sub urxvt::destroy_hook(&) {	899	sub urxvt::destroy_hook(&) {
1162	bless \shift, urxvt::destroy_hook::	900	bless \shift, urxvt::destroy_hook::
1163	}	901	}
		902
		903	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		904
		905	Dynamically enable the given hooks (named without the C<on_> prefix) for
		906	this extension, replacing any hook previously installed via C<enable> in
		907	this extension.
		908
		909	This is useful when you want to overwrite time-critical hooks only
		910	temporarily.
		911
		912	To install additional callbacks for the same hook, you can use the C<on>
		913	method of the C<urxvt::term> class.
		914
		915	=item $self->disable ($hook_name[, $hook_name..])
		916
		917	Dynamically disable the given hooks.
		918
		919	=cut
		920
		921	sub enable {
		922	my ($self, %hook) = @_;
		923	my $pkg = $self->{_pkg};
		924
		925	while (my ($name, $cb) = each %hook) {
		926	my $htype = $HOOKTYPE{uc $name};
		927	defined $htype
		928	or Carp::croak "unsupported hook type '$name'";
		929
		930	$self->set_should_invoke ($htype, +1)
		931	unless exists $self->{term}{_hook}[$htype]{$pkg};
		932
		933	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		934	}
		935	}
		936
		937	sub disable {
		938	my ($self, @hook) = @_;
		939	my $pkg = $self->{_pkg};
		940
		941	for my $name (@hook) {
		942	my $htype = $HOOKTYPE{uc $name};
		943	defined $htype
		944	or Carp::croak "unsupported hook type '$name'";
		945
		946	$self->set_should_invoke ($htype, -1)
		947	if delete $self->{term}{_hook}[$htype]{$pkg};
		948	}
		949	}
		950
		951	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		952
		953	Similar to the C<enable> enable, but installs additional callbacks for
		954	the given hook(s) (that is, it doesn't replace existing callbacks), and
		955	returns a guard object. When the guard object is destroyed the callbacks
		956	are disabled again.
		957
		958	=cut
		959
		960	sub urxvt::extension::on_disable::DESTROY {
		961	my $disable = shift;
		962
		963	my $term = delete $disable->{""};
		964
		965	while (my ($htype, $id) = each %$disable) {
		966	delete $term->{_hook}[$htype]{$id};
		967	$term->set_should_invoke ($htype, -1);
		968	}
		969	}
		970
		971	sub on {
		972	my ($self, %hook) = @_;
		973
		974	my $term = $self->{term};
		975
		976	my %disable = ( "" => $term );
		977
		978	while (my ($name, $cb) = each %hook) {
		979	my $htype = $HOOKTYPE{uc $name};
		980	defined $htype
		981	or Carp::croak "unsupported hook type '$name'";
		982
		983	$term->set_should_invoke ($htype, +1);
		984	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		985	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		986	}
		987
		988	bless \%disable, "urxvt::extension::on_disable"
		989	}
		990
		991	=item $self->bind_action ($hotkey, $action)
		992
		993	=item $self->x_resource ($pattern)
		994
		995	=item $self->x_resource_boolean ($pattern)
		996
		997	These methods support an additional C<%> prefix for C<$action> or
		998	C<$pattern> when called on an extension object, compared to the
		999	C<urxvt::term> methods of the same name - see the description of these
		1000	methods in the C<urxvt::term> class for details.
		1001
		1002	=cut
		1003
		1004	sub bind_action {
		1005	my ($self, $hotkey, $action) = @_;
		1006	$action =~ s/^%:/$_[0]{_name}:/;
		1007	$self->{term}->bind_action ($hotkey, $action)
		1008	}
		1009
		1010	sub x_resource {
		1011	my ($self, $name) = @_;
		1012	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1013	$self->{term}->x_resource ($name)
		1014	}
		1015
		1016	sub x_resource_boolean {
		1017	my ($self, $name) = @_;
		1018	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1019	$self->{term}->x_resource_boolean ($name)
		1020	}
		1021
		1022	=back
		1023
		1024	=cut
1164		1025
1165	package urxvt::anyevent;	1026	package urxvt::anyevent;
1166		1027
1167	=head2 The C<urxvt::anyevent> Class	1028	=head2 The C<urxvt::anyevent> Class
1168		1029
1169	The sole purpose of this class is to deliver an interface to the	1030	The sole purpose of this class is to deliver an interface to the
1170	C<AnyEvent> module - any module using it will work inside urxvt without	1031	C<AnyEvent> module - any module using it will work inside urxvt without
1171	further programming. The only exception is that you cannot wait on	1032	further programming. The only exception is that you cannot wait on
1172	condition variables, but non-blocking condvar use is ok. What this means	1033	condition variables, but non-blocking condvar use is ok.
1173	is that you cannot use blocking APIs, but the non-blocking variant should	1034
1174	work.	1035	In practical terms this means is that you cannot use blocking APIs, but
		1036	the non-blocking variant should work.
1175		1037
1176	=cut	1038	=cut
1177		1039
1178	our $VERSION = '5.23';	1040	our $VERSION = '5.23';
1179		1041
…		…
1247		1109
1248	package urxvt::term;	1110	package urxvt::term;
1249		1111
1250	=head2 The C<urxvt::term> Class	1112	=head2 The C<urxvt::term> Class
1251		1113
1252	=over 4	1114	=over
1253		1115
1254	=cut	1116	=cut
1255		1117
1256	# find on_xxx subs in the package and register them	1118	# find on_xxx subs in the package and register them
1257	# as hooks	1119	# as hooks
…		…
1263	urxvt::verbose 6, "register package $pkg to $self";	1125	urxvt::verbose 6, "register package $pkg to $self";
1264		1126
1265	@{"$pkg\::ISA"} = urxvt::term::extension::;	1127	@{"$pkg\::ISA"} = urxvt::term::extension::;
1266		1128
1267	my $proxy = bless {	1129	my $proxy = bless {
1268	_pkg => $pkg,	1130	_pkg => $pkg,
		1131	_name => ${"$pkg\::_NAME"}, # hackish
1269	argv => $argv,	1132	argv => $argv,
1270	}, $pkg;	1133	}, $pkg;
1271	Scalar::Util::weaken ($proxy->{term} = $self);	1134	Scalar::Util::weaken ($proxy->{term} = $self);
1272		1135
1273	$self->{_pkg}{$pkg} = $proxy;	1136	$self->{_pkg}{$pkg} = $proxy;
1274		1137
…		…
1277	$proxy->enable ($name => $ref);	1140	$proxy->enable ($name => $ref);
1278	}	1141	}
1279	}	1142	}
1280	}	1143	}
1281		1144
		1145	sub perl_libdirs {
		1146	map { split /:/ }
		1147	$_[0]->resource ("perl_lib"),
		1148	$ENV{URXVT_PERL_LIB},
		1149	"$ENV{HOME}/.urxvt/ext",
		1150	"$LIBDIR/perl"
		1151	}
		1152
		1153	# scan for available extensions and collect their metadata
		1154	sub scan_extensions {
		1155	my ($self) = @_;
		1156
		1157	return if exists $self->{meta};
		1158
		1159	my @urxvtdirs = perl_libdirs $self;
		1160	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1161
		1162	$self->{meta} = \my %meta;
		1163
		1164	# first gather extensions
		1165
		1166	my $gather = sub {
		1167	my ($dir, $core) = @_;
		1168
		1169	opendir my $fh, $dir
		1170	or return;
		1171
		1172	for my $ext (readdir $fh) {
		1173	$ext !~ /^\./
		1174	or next;
		1175
		1176	open my $fh, "<", "$dir/$ext"
		1177	or next;
		1178
		1179	-f $fh
		1180	or next;
		1181
		1182	$ext =~ s/\.uext$// or $core
		1183	or next;
		1184
		1185	my %ext = (dir => $dir);
		1186
		1187	while (<$fh>) {
		1188	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1189	my ($pattern, $type, $desc) = split /:/, $1;
		1190	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1191	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1192	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1193	} else {
		1194	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1195	}
		1196	} elsif (/^\s*(?:#|$)/) {
		1197	# skip other comments and empty lines
		1198	} else {
		1199	last; # stop parsing on first non-empty non-comment line
		1200	}
		1201	}
		1202
		1203	$meta{ext}{$ext} = \%ext;
		1204	}
		1205	};
		1206
		1207	# $gather->($_, 0) for @cpandirs;
		1208	$gather->($_, 1) for @urxvtdirs;
		1209
		1210	# and now merge resources
		1211
		1212	$meta{resource} = \my %resource;
		1213
		1214	while (my ($k, $v) = each %{ $meta{ext} }) {
		1215	#TODO: should check for extensions overriding each other
		1216	%resource = (%resource, %{ $v->{resource} });
		1217	}
		1218	}
		1219
1282	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1283		1221
1284	Creates a new terminal, very similar as if you had started it with system	1222	Creates a new terminal, very similar as if you had started it with system
1285	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1223	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1286	hash which defines the environment of the new terminal.	1224	hash which defines the environment of the new terminal.
…		…
1303	}	1241	}
1304		1242
1305	=item $term->destroy	1243	=item $term->destroy
1306		1244
1307	Destroy the terminal object (close the window, free resources	1245	Destroy the terminal object (close the window, free resources
1308	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1246	etc.). Please note that urxvt will not exit as long as any event
1309	watchers (timers, io watchers) are still active.	1247	watchers (timers, io watchers) are still active.
1310		1248
1311	=item $term->exec_async ($cmd[, @args])	1249	=item $term->exec_async ($cmd[, @args])
1312		1250
1313	Works like the combination of the C<fork>/C<exec> builtins, which executes	1251	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1346	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1284	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1347	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1285	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1348	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1286	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1349	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1287	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1350	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1288	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1351	urgentOnBell utmpInhibit visualBell	1289	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1352		1290
1353	=item $value = $term->resource ($name[, $newval])	1291	=item $value = $term->resource ($name[, $newval])
1354		1292
1355	Returns the current resource value associated with a given name and	1293	Returns the current resource value associated with a given name and
1356	optionally sets a new value. Setting values is most useful in the C<init>	1294	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1369		1307
1370	Here is a likely non-exhaustive list of resource names, not all of which	1308	Here is a likely non-exhaustive list of resource names, not all of which
1371	are supported in every build, please see the source file F</src/rsinc.h>	1309	are supported in every build, please see the source file F</src/rsinc.h>
1372	to see the actual list:	1310	to see the actual list:
1373		1311
1374	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1312	answerbackstring backgroundPixmap backspace_key blurradius
1375	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1313	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1376	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1314	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1377	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1315	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1378	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1316	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1379	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1317	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1382	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1320	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1383	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1321	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1384	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1322	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1385	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1323	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1386	term_name title transient_for transparent tripleclickwords urgentOnBell	1324	term_name title transient_for transparent tripleclickwords urgentOnBell
1387	utmpInhibit visualBell	1325	utmpInhibit visualBell rewrapMode disablePasteBrackets
1388		1326
1389	=cut	1327	=cut
1390		1328
1391	sub resource($$;$) {	1329	sub resource($$;$) {
1392	my ($self, $name) = (shift, shift);	1330	my ($self, $name) = (shift, shift);
…		…
1399	Returns the X-Resource for the given pattern, excluding the program or	1337	Returns the X-Resource for the given pattern, excluding the program or
1400	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1338	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1401	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1339	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1402	resource with that pattern exists.	1340	resource with that pattern exists.
1403		1341
		1342	Extensions that define extra resources also need to call this method
		1343	to access their values.
		1344
		1345	If the method is called on an extension object (basically, from an
		1346	extension), then the special prefix C<%.> will be replaced by the name of
		1347	the extension and a dot, and the lone string C<%> will be replaced by the
		1348	extension name itself. This makes it possible to code extensions so you
		1349	can rename them and get a new set of resources without having to change
		1350	the actual code.
		1351
1404	This method should only be called during the C<on_start> hook, as there is	1352	This method should only be called during the C<on_start> hook, as there is
1405	only one resource database per display, and later invocations might return	1353	only one resource database per display, and later invocations might return
1406	the wrong resources.	1354	the wrong resources.
1407		1355
1408	=item $success = $term->parse_keysym ($key, $octets)	1356	=item $value = $term->x_resource_boolean ($pattern)
1409		1357
		1358	Like C<x_resource>, above, but interprets the string value as a boolean
		1359	and returns C<1> for true values, C<0> for false values and C<undef> if
		1360	the resource or option isn't specified.
		1361
		1362	You should always use this method to parse boolean resources.
		1363
		1364	=cut
		1365
		1366	sub x_resource_boolean {
		1367	my $res = &x_resource;
		1368
		1369	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1370	}
		1371
		1372	=item $action = $term->lookup_keysym ($keysym, $state)
		1373
		1374	Returns the action bound to key combination C<($keysym, $state)>,
		1375	if a binding for it exists, and C<undef> otherwise.
		1376
		1377	=item $success = $term->bind_action ($key, $action)
		1378
1410	Adds a key binding exactly as specified via a resource. See the	1379	Adds a key binding exactly as specified via a C<keysym> resource. See the
1411	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1380	C<keysym> resource in the urxvt(1) manpage.
1412		1381
1413	=item $term->register_command ($keysym, $modifiermask, $string)	1382	To add default bindings for actions, an extension should call C<<
		1383	->bind_action >> in its C<init> hook for every such binding. Doing it
		1384	in the C<init> hook allows users to override or remove the binding
		1385	again.
1414		1386
1415	Adds a key binding. This is a lower level api compared to	1387	Example: the C<searchable-scrollback> by default binds itself
1416	C<parse_keysym>, as it expects a parsed key description, and can be	1388	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1417	used only inside either the C<on_init> hook, to add a binding, or the	1389	$term->bind_action >>.
1418	C<on_register_command> hook, to modify a parsed binding.	1390
		1391	sub init {
		1392	my ($self) = @_;
		1393
		1394	$self->bind_action ("M-s" => "%:start");
		1395	}
1419		1396
1420	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
1421		1398
1422	Return and optionally change the current rendition. Text that is output by	1399	Return and optionally change the current rendition. Text that is output by
1423	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1500	This method returns an urxvt::overlay object. The overlay will be visible	1477	This method returns an urxvt::overlay object. The overlay will be visible
1501	as long as the perl object is referenced.	1478	as long as the perl object is referenced.
1502		1479
1503	The methods currently supported on C<urxvt::overlay> objects are:	1480	The methods currently supported on C<urxvt::overlay> objects are:
1504		1481
1505	=over 4	1482	=over
1506		1483
1507	=item $overlay->set ($x, $y, $text[, $rend])	1484	=item $overlay->set ($x, $y, $text[, $rend])
1508		1485
1509	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1486	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1510	text in rxvt-unicode's special encoding and an array of rendition values	1487	text in rxvt-unicode's special encoding and an array of rendition values
…		…
1581		1558
1582	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1583		1560
1584	Write the given text string to the screen, as if output by the application	1561	Write the given text string to the screen, as if output by the application
1585	running inside the terminal. It may not contain command sequences (escape	1562	running inside the terminal. It may not contain command sequences (escape
1586	codes), but is free to use line feeds, carriage returns and tabs. The	1563	codes - see C<cmd_parse> for that), but is free to use line feeds,
1587	string is a normal text string, not in locale-dependent encoding.	1564	carriage returns and tabs. The string is a normal text string, not in
		1565	locale-dependent encoding.
1588		1566
1589	Normally its not a good idea to use this function, as programs might be	1567	Normally its not a good idea to use this function, as programs might be
1590	confused by changes in cursor position or scrolling. Its useful inside a	1568	confused by changes in cursor position or scrolling. Its useful inside a
1591	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1592		1570
…		…
1600	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1601	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1602		1580
1603	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1604		1582
1605	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1583	Write the octets given in C<$octets> to the tty (i.e. as user input
		1584	to the program, see C<cmd_parse> for the opposite direction). To pass
1606	pass characters instead of octets, you should convert your strings first	1585	characters instead of octets, you should convert your strings first to the
1607	to the locale-specific encoding using C<< $term->locale_encode >>.	1586	locale-specific encoding using C<< $term->locale_encode >>.
		1587
		1588	=item $term->tt_write_user_input ($octets)
		1589
		1590	Like C<tt_write>, but should be used when writing strings in response to
		1591	the user pressing a key, to invoke the additional actions requested by
		1592	the user for that case (C<tt_write> doesn't do that).
		1593
		1594	The typical use case would be inside C<on_action> hooks.
1608		1595
1609	=item $term->tt_paste ($octets)	1596	=item $term->tt_paste ($octets)
1610		1597
1611	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1598	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1612	CR and bracketing the data with control sequences if bracketed paste mode	1599	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1651		1638
1652	=item $term->key_release ($state, $keycode[, $time])	1639	=item $term->key_release ($state, $keycode[, $time])
1653		1640
1654	Deliver various fake events to to terminal.	1641	Deliver various fake events to to terminal.
1655		1642
1656	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1657		1644
1658	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1659		1646
1660	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1661		1648
1662	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1663		1650
1664	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1665		1652
1666	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1667		1654
1668	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1669		1656
1670	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1671		1658
1672	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1673		1660
1674	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1675		1662
1676	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1677		1664
1678	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1679		1666
1680	Return various integers describing terminal characteristics.	1667	Return various integers describing terminal characteristics. If an
		1668	argument is given, changes the value and returns the previous one.
1681		1669
1682	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1683		1671
1684	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1685		1673
…		…
1722		1710
1723	=item $cursor_is_hidden = $term->hidden_cursor	1711	=item $cursor_is_hidden = $term->hidden_cursor
1724		1712
1725	Returns whether the cursor is currently hidden or not.	1713	Returns whether the cursor is currently hidden or not.
1726		1714
		1715	=item $priv_modes = $term->priv_modes
		1716
		1717	Returns a bitset with the state of DEC private modes.
		1718
		1719	Example:
		1720
		1721	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1722	# mouse reporting is turned on
		1723	}
		1724
1727	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1728		1726
1729	Returns the row number of the topmost displayed line. Maximum value is	1727	Returns the row number of the topmost displayed line and changes it,
1730	C<0>, which displays the normal terminal contents. Lower values scroll	1728	if an argument is given. Values greater than or equal to C<0> display
1731	this many lines into the scrollback buffer.	1729	the terminal contents. Lower values scroll this many lines into the
		1730	scrollback buffer.
1732		1731
1733	=item $term->want_refresh	1732	=item $term->want_refresh
1734		1733
1735	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1734	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1736	compare the on-screen display with its stored representation. If they	1735	compare the on-screen display with its stored representation. If they
1737	differ, it redraws the differences.	1736	differ, it redraws the differences.
1738		1737
1739	Used after changing terminal contents to display them.	1738	Used after changing terminal contents to display them.
		1739
		1740	=item $term->refresh_check
		1741
		1742	Checks if a refresh has been requested and, if so, schedules one.
1740		1743
1741	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1744	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1742		1745
1743	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1746	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1744	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1747	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1790		1793
1791	Create and return a new C<urxvt::line> object that stores information	1794	Create and return a new C<urxvt::line> object that stores information
1792	about the logical line that row C<$row_number> is part of. It supports the	1795	about the logical line that row C<$row_number> is part of. It supports the
1793	following methods:	1796	following methods:
1794		1797
1795	=over 4	1798	=over
1796		1799
1797	=item $text = $line->t ([$new_text])	1800	=item $text = $line->t ([$new_text])
1798		1801
1799	Returns or replaces the full text of the line, similar to C<ROW_t>	1802	Returns or replaces the full text of the line, similar to C<ROW_t>
1800		1803
…		…
1846	}	1849	}
1847		1850
1848	sub urxvt::line::t {	1851	sub urxvt::line::t {
1849	my ($self) = @_;	1852	my ($self) = @_;
1850		1853
1851	if (@_ > 1)	1854	if (@_ > 1) {
1852	{
1853	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1855	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1854	for $self->{beg} .. $self->{end};	1856	for $self->{beg} .. $self->{end};
1855	}	1857	}
1856		1858
1857	defined wantarray &&	1859	defined wantarray &&
1858	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1860	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1859	0, $self->{len}	1861	0, $self->{len}
1860	}	1862	}
1861		1863
1862	sub urxvt::line::r {	1864	sub urxvt::line::r {
1863	my ($self) = @_;	1865	my ($self) = @_;
1864		1866
1865	if (@_ > 1)	1867	if (@_ > 1) {
1866	{
1867	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1868	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1868	for $self->{beg} .. $self->{end};	1869	for $self->{beg} .. $self->{end};
1869	}	1870	}
1870		1871
1871	if (defined wantarray) {	1872	if (defined wantarray) {
1872	my $rend = [	1873	my $rend = [
1873	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1874	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1874	];	1875	];
…		…
1982		1983
1983	package urxvt::popup;	1984	package urxvt::popup;
1984		1985
1985	=head2 The C<urxvt::popup> Class	1986	=head2 The C<urxvt::popup> Class
1986		1987
1987	=over 4	1988	=over
1988		1989
1989	=cut	1990	=cut
1990		1991
1991	sub add_item {	1992	sub add_item {
1992	my ($self, $item) = @_;	1993	my ($self, $item) = @_;
…		…
2128	->cb (sub {	2129	->cb (sub {
2129	$term->{overlay}->set (0, 0,	2130	$term->{overlay}->set (0, 0,
2130	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2131	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2131	});	2132	});
2132		2133
2133	=over 4	2134	=over
2134		2135
2135	=item $timer = new urxvt::timer	2136	=item $timer = new urxvt::timer
2136		2137
2137	Create a new timer object in started state. It is scheduled to fire	2138	Create a new timer object in started state. It is scheduled to fire
2138	immediately.	2139	immediately.
…		…
2187	sysread $term->{socket}, my $buf, 8192	2188	sysread $term->{socket}, my $buf, 8192
2188	or end-of-file;	2189	or end-of-file;
2189	});	2190	});
2190		2191
2191		2192
2192	=over 4	2193	=over
2193		2194
2194	=item $iow = new urxvt::iow	2195	=item $iow = new urxvt::iow
2195		2196
2196	Create a new io watcher object in stopped state.	2197	Create a new io watcher object in stopped state.
2197		2198
…		…
2224		2225
2225	This class implements idle watchers, that get called automatically when	2226	This class implements idle watchers, that get called automatically when
2226	the process is idle. They should return as fast as possible, after doing	2227	the process is idle. They should return as fast as possible, after doing
2227	some useful work.	2228	some useful work.
2228		2229
2229	=over 4	2230	=over
2230		2231
2231	=item $iw = new urxvt::iw	2232	=item $iw = new urxvt::iw
2232		2233
2233	Create a new idle watcher object in stopped state.	2234	Create a new idle watcher object in stopped state.
2234		2235
…		…
2259	->cb (sub {	2260	->cb (sub {
2260	my ($pw, $exit_status) = @_;	2261	my ($pw, $exit_status) = @_;
2261	...	2262	...
2262	});	2263	});
2263		2264
2264	=over 4	2265	=over
2265		2266
2266	=item $pw = new urxvt::pw	2267	=item $pw = new urxvt::pw
2267		2268
2268	Create a new process watcher in stopped state.	2269	Create a new process watcher in stopped state.
2269		2270
…		…
2286	=head2 URXVT_PERL_VERBOSITY	2287	=head2 URXVT_PERL_VERBOSITY
2287		2288
2288	This variable controls the verbosity level of the perl extension. Higher	2289	This variable controls the verbosity level of the perl extension. Higher
2289	numbers indicate more verbose output.	2290	numbers indicate more verbose output.
2290		2291
2291	=over 4	2292	=over
2292		2293
2293	=item == 0 - fatal messages	2294	=item == 0 - fatal messages
2294		2295
2295	=item >= 3 - script loading and management	2296	=item >= 3 - script loading and management
2296		2297

Diff Legend

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