[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.212 by root, Wed Jun 6 15:06:41 2012 UTC vs.
Revision 1.257 by root, Thu Jul 13 10:31:27 2017 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 $HOME:
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 using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -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
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.
		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata.
		121
		122	Currently, it recognises only one such comment:
473		123
474	=over 4	124	=over 4
475		125
476	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
477		127
478	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
479	extension. This member I<must not> be changed in any way.	129	C<name> is the resource name, C<type> is the resource type, C<boolean>
480		130	or C<string>, and C<desc> is the resource description.
481	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
482
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		131
491	=back	132	=back
492		133
493	=head2 Hooks	134	=head2 Hooks
494		135
…		…
663		304
664	=item on_refresh_end $term	305	=item on_refresh_end $term
665		306
666	Called just after the screen gets redrawn. See C<on_refresh_begin>.	307	Called just after the screen gets redrawn. See C<on_refresh_begin>.
667		308
		309	=item on_action $term, $string
		310
		311	Called whenever an action is invoked for the corresponding extension
		312	(e.g. via a C<extension:string> builtin action bound to a key, see
		313	description of the B<keysym> resource in the urxvt(1) manpage). The
		314	event is simply the action string. Note that an action event is always
		315	associated to a single extension.
		316
668	=item on_user_command $term, $string	317	=item on_user_command $term, $string DEPRECATED
669		318
670	Called whenever a user-configured event is being activated (e.g. via	319	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>	320	a C<perl:string> action bound to a key, see description of the B<keysym>
672	resource in the @@RXVT_NAME@@(1) manpage).	321	resource in the urxvt(1) manpage).
673		322
674	The event is simply the action string. This interface is assumed to change	323	The event is simply the action string. This interface is going away in
675	slightly in the future.	324	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		325
684	=item on_resize_all_windows $term, $new_width, $new_height	326	=item on_resize_all_windows $term, $new_width, $new_height
685		327
686	Called just after the new window size has been calculated, but before	328	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	329	windows are actually being resized or hints are being set. If this hook
688	returns TRUE, setting of the window hints is being skipped.	330	returns a true value, setting of the window hints is being skipped.
689		331
690	=item on_x_event $term, $event	332	=item on_x_event $term, $event
691		333
692	Called on every X event received on the vt window (and possibly other	334	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	335	windows). Should only be used as a last resort. Most event structure
…		…
733	(real, not screen-based) row and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
734		376
735	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
736	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
737		379
738	subwindow.
739
740	=item on_client_message $term, $event	380	=item on_client_message $term, $event
741		381
742	=item on_wm_protocols $term, $event	382	=item on_wm_protocols $term, $event
743		383
744	=item on_wm_delete_window $term, $event	384	=item on_wm_delete_window $term, $event
…		…
755	=cut	395	=cut
756		396
757	package urxvt;	397	package urxvt;
758		398
759	use utf8;	399	use utf8;
760	use strict;	400	use strict 'vars';
761	use Carp ();	401	use Carp ();
762	use Scalar::Util ();	402	use Scalar::Util ();
763	use List::Util ();	403	use List::Util ();
764		404
765	our $VERSION = 1;	405	our $VERSION = 1;
…		…
871	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,	511	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
872	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	512	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
873	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	513	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
874		514
875	Various constants for use in X calls and event processing.	515	Various constants for use in X calls and event processing.
		516
		517	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		518	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		519	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		520	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		521	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		522	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		523	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtModeMouse,
		524	PrivMode_ExtMouseRight, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		525	PrivMode_Default
		526
		527	Constants for checking DEC private modes.
876		528
877	=back	529	=back
878		530
879	=head2 RENDITION	531	=head2 RENDITION
880		532
…		…
946	no warnings 'utf8';	598	no warnings 'utf8';
947		599
948	sub parse_resource {	600	sub parse_resource {
949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	601	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
950		602
951	$term->scan_meta;	603	$term->scan_extensions;
952		604
953	my $r = $term->{meta}{resource};	605	my $r = $term->{meta}{resource};
		606	keys %$r; # reset iterator
954	while (my ($pattern, $v) = each %$r) {	607	while (my ($k, $v) = each %$r) {
		608	my $pattern = $k;
955	$name =~ y/-/./ if $isarg;	609	$pattern =~ y/./-/ if $isarg;
956		610	my $prefix = $name;
957	if (	611	my $suffix;
958	$pattern =~ /\.$/	612	if ($pattern =~ /\-$/) {
959	? $pattern eq substr $name, 0, length $pattern	613	$prefix = substr $name, 0, length $pattern;
960	: $pattern eq $name	614	$suffix = substr $name, length $pattern;
961	) {	615	}
		616	if ($pattern eq $prefix) {
962	$name = "$urxvt::RESCLASS.$name";	617	$name = "$urxvt::RESCLASS.$k$suffix";
963		618
964	push @TERM_EXT, $v->[0];	619	push @{ $term->{perl_ext_3} }, $v->[0];
		620
		621	return 1 unless $isarg;
965		622
966	if ($v->[1] eq "boolean") {	623	if ($v->[1] eq "boolean") {
967	$term->put_option_db ($name, $flag ? "true" : "false");	624	$term->put_option_db ($name, $flag ? "true" : "false");
968	return 1;	625	return 1;
969	} else {	626	} else {
…		…
977	}	634	}
978		635
979	sub usage {	636	sub usage {
980	my ($term, $usage_type) = @_;	637	my ($term, $usage_type) = @_;
981		638
982	$term->scan_meta;	639	$term->scan_extensions;
983		640
984	my $r = $term->{meta}{resource};	641	my $r = $term->{meta}{resource};
985		642
986	for my $pattern (sort keys %$r) {	643	for my $pattern (sort keys %$r) {
987	my ($ext, $type, $desc) = @{ $r->{$pattern} };	644	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
996	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;	653	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
997	} else {	654	} else {
998	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;	655	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
999	}	656	}
1000	} else {	657	} else {
		658	$pattern =~ s/\.$/.*/g;
1001	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;	659	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
1002	}	660	}
1003	}	661	}
1004	}	662	}
1005		663
…		…
1022	$pkg =~ s/[^[:word:]]/_/g;	680	$pkg =~ s/[^[:word:]]/_/g;
1023	$pkg = "urxvt::ext::$pkg";	681	$pkg = "urxvt::ext::$pkg";
1024		682
1025	verbose 3, "loading extension '$path' into package '$pkg'";	683	verbose 3, "loading extension '$path' into package '$pkg'";
1026		684
		685	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		686
1027	open my $fh, "<:raw", $path	687	open my $fh, "<:raw", $path
1028	or die "$path: $!";	688	or die "$path: $!";
1029		689
1030	my $source =	690	my $source =
1031	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	691	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
1032	. "#line 1 \"$path\"\n{\n"	692	. "#line 1 \"$path\"\n{\n"
1033	. (do { local $/; <$fh> })	693	. (do { local $/; <$fh> })
1034	. "\n};\n1";	694	. "\n};\n1";
1035		695
1036	eval $source	696	eval $source
…		…
1045	# called by the rxvt core	705	# called by the rxvt core
1046	sub invoke {	706	sub invoke {
1047	local $TERM = shift;	707	local $TERM = shift;
1048	my $htype = shift;	708	my $htype = shift;
1049		709
1050	if ($htype == 0) { # INIT	710	if ($htype == HOOK_INIT) {
1051	my @dirs = $TERM->perl_libdirs;	711	my @dirs = $TERM->perl_libdirs;
		712
		713	$TERM->scan_extensions;
1052		714
1053	my %ext_arg;	715	my %ext_arg;
1054		716
1055	{	717	{
1056	my @init = @TERM_INIT;	718	my @init = @TERM_INIT;
…		…
1059	my @pkg = @TERM_EXT;	721	my @pkg = @TERM_EXT;
1060	@TERM_EXT = ();	722	@TERM_EXT = ();
1061	$TERM->register_package ($_) for @pkg;	723	$TERM->register_package ($_) for @pkg;
1062	}	724	}
1063		725
		726	for (
1064	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	727	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		728	@{ delete $TERM->{perl_ext_3} }
		729	) {
1065	if ($_ eq "default") {	730	if ($_ eq "default") {
		731
		732	$ext_arg{$_} = []
1066	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	733	for qw(selection option-popup selection-popup readline searchable-scrollback);
		734
		735	for ($TERM->_keysym_resources) {
		736	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		737	next unless /^([A-Za-z0-9_\-]+):/;
		738
		739	my $ext = $1;
		740
		741	$ext_arg{$ext} = [];
		742	}
		743
1067	} elsif (/^-(.*)$/) {	744	} elsif (/^-(.*)$/) {
1068	delete $ext_arg{$1};	745	delete $ext_arg{$1};
		746
1069	} elsif (/^([^<]+)<(.*)>$/) {	747	} elsif (/^([^<]+)<(.*)>$/) {
1070	push @{ $ext_arg{$1} }, $2;	748	push @{ $ext_arg{$1} }, $2;
		749
1071	} else {	750	} else {
1072	$ext_arg{$_} \|\|= [];	751	$ext_arg{$_} \|\|= [];
1073	}	752	}
1074	}	753	}
1075		754
…		…
1091		770
1092	if (my $cb = $TERM->{_hook}[$htype]) {	771	if (my $cb = $TERM->{_hook}[$htype]) {
1093	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	772	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1094	if $verbosity >= 10;	773	if $verbosity >= 10;
1095		774
		775	if ($htype == HOOK_ACTION) {
		776	# this hook is only sent to the extension with the name
		777	# matching the first arg
		778	my $pkg = shift;
		779	$pkg =~ y/-/_/;
		780	$pkg = "urxvt::ext::$pkg";
		781
		782	$cb = $cb->{$pkg}
		783	or return undef; #TODO: maybe warn user?
		784
		785	$cb = { $pkg => $cb };
		786	}
		787
1096	for my $pkg (keys %$cb) {	788	for my $pkg (keys %$cb) {
1097	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	789	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
1098	$retval \|\|= $retval_;	790	$retval \|\|= $retval_;
1099		791
1100	if ($@) {	792	if ($@) {
1101	$TERM->ungrab; # better to lose the grab than the session	793	$TERM->ungrab; # better to lose the grab than the session
1102	warn $@;	794	warn $@;
…		…
1105		797
1106	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	798	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1107	if $verbosity >= 11;	799	if $verbosity >= 11;
1108	}	800	}
1109		801
1110	if ($htype == 1) { # DESTROY	802	if ($htype == HOOK_DESTROY) {
1111	# clear package objects	803	# clear package objects
1112	%$_ = () for values %{ $TERM->{_pkg} };	804	%$_ = () for values %{ $TERM->{_pkg} };
1113		805
1114	# clear package	806	# clear package
1115	%$TERM = ();	807	%$TERM = ();
…		…
1145	}	837	}
1146	}	838	}
1147	($mask, @color{qw(fg bg)}, \@failed)	839	($mask, @color{qw(fg bg)}, \@failed)
1148	}	840	}
1149		841
1150	# urxvt::term::extension
1151
1152	package urxvt::term::extension;	842	package urxvt::term::extension;
1153		843
1154	sub enable {	844	=head2 The C<urxvt::term::extension> class
1155	my ($self, %hook) = @_;
1156	my $pkg = $self->{_pkg};
1157		845
1158	while (my ($name, $cb) = each %hook) {	846	Each extension attached to a terminal object is represented by
1159	my $htype = $HOOKTYPE{uc $name};	847	a C<urxvt::term::extension> object.
1160	defined $htype
1161	or Carp::croak "unsupported hook type '$name'";
1162		848
1163	$self->set_should_invoke ($htype, +1)	849	You can use these objects, which are passed to all callbacks to store any
1164	unless exists $self->{term}{_hook}[$htype]{$pkg};	850	state related to the terminal and extension instance.
1165		851
1166	$self->{term}{_hook}[$htype]{$pkg} = $cb;	852	The methods (And data members) documented below can be called on extension
1167	}	853	objects, in addition to call methods documented for the <urxvt::term>
1168	}	854	class.
1169		855
1170	sub disable {	856	=over 4
1171	my ($self, @hook) = @_;
1172	my $pkg = $self->{_pkg};
1173		857
1174	for my $name (@hook) {	858	=item $urxvt_term = $self->{term}
1175	my $htype = $HOOKTYPE{uc $name};
1176	defined $htype
1177	or Carp::croak "unsupported hook type '$name'";
1178		859
1179	$self->set_should_invoke ($htype, -1)	860	Returns the C<urxvt::term> object associated with this instance of the
1180	if delete $self->{term}{_hook}[$htype]{$pkg};	861	extension. This member I<must not> be changed in any way.
1181	}	862
1182	}	863	=cut
1183		864
1184	our $AUTOLOAD;	865	our $AUTOLOAD;
1185		866
1186	sub AUTOLOAD {	867	sub AUTOLOAD {
1187	$AUTOLOAD =~ /:([^:]+)$/	868	$AUTOLOAD =~ /:([^:]+)$/
…		…
1200		881
1201	sub DESTROY {	882	sub DESTROY {
1202	# nop	883	# nop
1203	}	884	}
1204		885
1205	# urxvt::destroy_hook	886	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1206		887
1207	sub urxvt::destroy_hook::DESTROY {	888	sub urxvt::destroy_hook::DESTROY {
1208	${$_[0]}->();	889	${$_[0]}->();
1209	}	890	}
1210		891
1211	sub urxvt::destroy_hook(&) {	892	sub urxvt::destroy_hook(&) {
1212	bless \shift, urxvt::destroy_hook::	893	bless \shift, urxvt::destroy_hook::
1213	}	894	}
		895
		896	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		897
		898	Dynamically enable the given hooks (named without the C<on_> prefix) for
		899	this extension, replacing any hook previously installed via C<enable> in
		900	this extension.
		901
		902	This is useful when you want to overwrite time-critical hooks only
		903	temporarily.
		904
		905	To install additional callbacks for the same hook, you can use the C<on>
		906	method of the C<urxvt::term> class.
		907
		908	=item $self->disable ($hook_name[, $hook_name..])
		909
		910	Dynamically disable the given hooks.
		911
		912	=cut
		913
		914	sub enable {
		915	my ($self, %hook) = @_;
		916	my $pkg = $self->{_pkg};
		917
		918	while (my ($name, $cb) = each %hook) {
		919	my $htype = $HOOKTYPE{uc $name};
		920	defined $htype
		921	or Carp::croak "unsupported hook type '$name'";
		922
		923	$self->set_should_invoke ($htype, +1)
		924	unless exists $self->{term}{_hook}[$htype]{$pkg};
		925
		926	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		927	}
		928	}
		929
		930	sub disable {
		931	my ($self, @hook) = @_;
		932	my $pkg = $self->{_pkg};
		933
		934	for my $name (@hook) {
		935	my $htype = $HOOKTYPE{uc $name};
		936	defined $htype
		937	or Carp::croak "unsupported hook type '$name'";
		938
		939	$self->set_should_invoke ($htype, -1)
		940	if delete $self->{term}{_hook}[$htype]{$pkg};
		941	}
		942	}
		943
		944	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		945
		946	Similar to the C<enable> enable, but installs additional callbacks for
		947	the given hook(s) (that is, it doesn't replace existing callbacks), and
		948	returns a guard object. When the guard object is destroyed the callbacks
		949	are disabled again.
		950
		951	=cut
		952
		953	sub urxvt::extension::on_disable::DESTROY {
		954	my $disable = shift;
		955
		956	my $term = delete $disable->{""};
		957
		958	while (my ($htype, $id) = each %$disable) {
		959	delete $term->{_hook}[$htype]{$id};
		960	$term->set_should_invoke ($htype, -1);
		961	}
		962	}
		963
		964	sub on {
		965	my ($self, %hook) = @_;
		966
		967	my $term = $self->{term};
		968
		969	my %disable = ( "" => $term );
		970
		971	while (my ($name, $cb) = each %hook) {
		972	my $htype = $HOOKTYPE{uc $name};
		973	defined $htype
		974	or Carp::croak "unsupported hook type '$name'";
		975
		976	$term->set_should_invoke ($htype, +1);
		977	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		978	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		979	}
		980
		981	bless \%disable, "urxvt::extension::on_disable"
		982	}
		983
		984	=item $self->bind_action ($hotkey, $action)
		985
		986	=item $self->x_resource ($pattern)
		987
		988	=item $self->x_resource_boolean ($pattern)
		989
		990	These methods support an additional C<%> prefix for C<$action> or
		991	C<$pattern> when called on an extension object, compared to the
		992	C<urxvt::term> methods of the same name - see the description of these
		993	methods in the C<urxvt::term> class for details.
		994
		995	=cut
		996
		997	sub bind_action {
		998	my ($self, $hotkey, $action) = @_;
		999	$action =~ s/^%:/$_[0]{_name}:/;
		1000	$self->{term}->bind_action ($hotkey, $action)
		1001	}
		1002
		1003	sub x_resource {
		1004	my ($self, $name) = @_;
		1005	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		1006	$self->{term}->x_resource ($name)
		1007	}
		1008
		1009	sub x_resource_boolean {
		1010	my ($self, $name) = @_;
		1011	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		1012	$self->{term}->x_resource_boolean ($name)
		1013	}
		1014
		1015	=back
		1016
		1017	=cut
1214		1018
1215	package urxvt::anyevent;	1019	package urxvt::anyevent;
1216		1020
1217	=head2 The C<urxvt::anyevent> Class	1021	=head2 The C<urxvt::anyevent> Class
1218		1022
…		…
1314	urxvt::verbose 6, "register package $pkg to $self";	1118	urxvt::verbose 6, "register package $pkg to $self";
1315		1119
1316	@{"$pkg\::ISA"} = urxvt::term::extension::;	1120	@{"$pkg\::ISA"} = urxvt::term::extension::;
1317		1121
1318	my $proxy = bless {	1122	my $proxy = bless {
1319	_pkg => $pkg,	1123	_pkg => $pkg,
		1124	_name => ${"$pkg\::_NAME"}, # hackish
1320	argv => $argv,	1125	argv => $argv,
1321	}, $pkg;	1126	}, $pkg;
1322	Scalar::Util::weaken ($proxy->{term} = $self);	1127	Scalar::Util::weaken ($proxy->{term} = $self);
1323		1128
1324	$self->{_pkg}{$pkg} = $proxy;	1129	$self->{_pkg}{$pkg} = $proxy;
1325		1130
…		…
1336	$ENV{URXVT_PERL_LIB},	1141	$ENV{URXVT_PERL_LIB},
1337	"$ENV{HOME}/.urxvt/ext",	1142	"$ENV{HOME}/.urxvt/ext",
1338	"$LIBDIR/perl"	1143	"$LIBDIR/perl"
1339	}	1144	}
1340		1145
1341	sub scan_meta {	1146	# scan for available extensions and collect their metadata
		1147	sub scan_extensions {
1342	my ($self) = @_;	1148	my ($self) = @_;
		1149
		1150	return if exists $self->{meta};
		1151
1343	my @libdirs = perl_libdirs $self;	1152	my @urxvtdirs = perl_libdirs $self;
		1153	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1344		1154
1345	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1346
1347	my %meta;
1348
1349	$self->{meta_libdirs} = join "\x00", @libdirs;
1350	$self->{meta} = \%meta;	1155	$self->{meta} = \my %meta;
1351		1156
1352	for my $dir (reverse @libdirs) {	1157	# first gather extensions
		1158
		1159	my $gather = sub {
		1160	my ($dir, $core) = @_;
		1161
1353	opendir my $fh, $dir	1162	opendir my $fh, $dir
1354	or next;	1163	or return;
		1164
1355	for my $ext (readdir $fh) {	1165	for my $ext (readdir $fh) {
1356	$ext ne "."	1166	$ext !~ /^\./
1357	and $ext ne ".."
1358	and open my $fh, "<", "$dir/$ext"
1359	or next;	1167	or next;
1360		1168
		1169	open my $fh, "<", "$dir/$ext"
		1170	or next;
		1171
		1172	-f $fh
		1173	or next;
		1174
		1175	$ext =~ s/\.uext$// or $core
		1176	or next;
		1177
		1178	my %ext = (dir => $dir);
		1179
1361	while (<$fh>) {	1180	while (<$fh>) {
1362	if (/^#:META:X_RESOURCE:(.*)/) {	1181	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1363	my ($pattern, $type, $desc) = split /:/, $1;	1182	my ($pattern, $type, $desc) = split /:/, $1;
1364	$pattern =~ s/^%(?:\.\|$)/$ext./g; # % in pattern == extension name	1183	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1365	if ($pattern =~ /[^a-zA-Z\.]/) {	1184	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1366	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1185	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1367	} else {	1186	} else {
1368	$meta{resource}{$pattern} = [$ext, $type, $desc];	1187	$ext{resource}{$pattern} = [$ext, $type, $desc];
1369	}	1188	}
1370	} elsif (/^\s*(?:#\|$)/) {	1189	} elsif (/^\s*(?:#\|$)/) {
1371	# skip other comments and empty lines	1190	# skip other comments and empty lines
1372	} else {	1191	} else {
1373	last; # stop parsing on first non-empty non-comment line	1192	last; # stop parsing on first non-empty non-comment line
1374	}	1193	}
1375	}	1194	}
		1195
		1196	$meta{ext}{$ext} = \%ext;
1376	}	1197	}
		1198	};
		1199
		1200	# $gather->($_, 0) for @cpandirs;
		1201	$gather->($_, 1) for @urxvtdirs;
		1202
		1203	# and now merge resources
		1204
		1205	$meta{resource} = \my %resource;
		1206
		1207	while (my ($k, $v) = each %{ $meta{ext} }) {
		1208	#TODO: should check for extensions overriding each other
		1209	%resource = (%resource, %{ $v->{resource} });
1377	}	1210	}
1378	}	1211	}
1379		1212
1380	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1213	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1381		1214
…		…
1401	}	1234	}
1402		1235
1403	=item $term->destroy	1236	=item $term->destroy
1404		1237
1405	Destroy the terminal object (close the window, free resources	1238	Destroy the terminal object (close the window, free resources
1406	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1239	etc.). Please note that urxvt will not exit as long as any event
1407	watchers (timers, io watchers) are still active.	1240	watchers (timers, io watchers) are still active.
1408		1241
1409	=item $term->exec_async ($cmd[, @args])	1242	=item $term->exec_async ($cmd[, @args])
1410		1243
1411	Works like the combination of the C<fork>/C<exec> builtins, which executes	1244	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1467		1300
1468	Here is a likely non-exhaustive list of resource names, not all of which	1301	Here is a likely non-exhaustive list of resource names, not all of which
1469	are supported in every build, please see the source file F</src/rsinc.h>	1302	are supported in every build, please see the source file F</src/rsinc.h>
1470	to see the actual list:	1303	to see the actual list:
1471		1304
1472	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1305	answerbackstring backgroundPixmap backspace_key blurradius
1473	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1306	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1474	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1307	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1475	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1308	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1476	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1309	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1477	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1310	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1497	Returns the X-Resource for the given pattern, excluding the program or	1330	Returns the X-Resource for the given pattern, excluding the program or
1498	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1331	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1499	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1332	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1500	resource with that pattern exists.	1333	resource with that pattern exists.
1501		1334
		1335	Extensions that define extra resources also need to call this method
		1336	to access their values.
		1337
		1338	If the method is called on an extension object (basically, from an
		1339	extension), then the special prefix C<%.> will be replaced by the name of
		1340	the extension and a dot, and the lone string C<%> will be replaced by the
		1341	extension name itself. This makes it possible to code extensions so you
		1342	can rename them and get a new set of resources without having to change
		1343	the actual code.
		1344
1502	This method should only be called during the C<on_start> hook, as there is	1345	This method should only be called during the C<on_start> hook, as there is
1503	only one resource database per display, and later invocations might return	1346	only one resource database per display, and later invocations might return
1504	the wrong resources.	1347	the wrong resources.
1505		1348
1506	=item $value = $term->x_resource_boolean ($pattern)	1349	=item $value = $term->x_resource_boolean ($pattern)
…		…
1517	my $res = &x_resource;	1360	my $res = &x_resource;
1518		1361
1519	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1362	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1520	}	1363	}
1521		1364
1522	=item $success = $term->parse_keysym ($key, $octets)	1365	=item $action = $term->lookup_keysym ($keysym, $state)
1523		1366
		1367	Returns the action bound to key combination C<($keysym, $state)>,
		1368	if a binding for it exists, and C<undef> otherwise.
		1369
		1370	=item $success = $term->bind_action ($key, $action)
		1371
1524	Adds a key binding exactly as specified via a resource. See the	1372	Adds a key binding exactly as specified via a C<keysym> resource. See the
1525	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1373	C<keysym> resource in the urxvt(1) manpage.
1526		1374
1527	=item $term->register_command ($keysym, $modifiermask, $string)	1375	To add default bindings for actions, an extension should call C<<
		1376	->bind_action >> in its C<init> hook for every such binding. Doing it
		1377	in the C<init> hook allows users to override or remove the binding
		1378	again.
1528		1379
1529	Adds a key binding. This is a lower level api compared to	1380	Example: the C<searchable-scrollback> by default binds itself
1530	C<parse_keysym>, as it expects a parsed key description, and can be	1381	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1531	used only inside either the C<on_init> hook, to add a binding, or the	1382	$term->bind_action >>.
1532	C<on_register_command> hook, to modify a parsed binding.	1383
		1384	sub init {
		1385	my ($self) = @_;
		1386
		1387	$self->bind_action ("M-s" => "%:start");
		1388	}
1533		1389
1534	=item $rend = $term->rstyle ([$new_rstyle])	1390	=item $rend = $term->rstyle ([$new_rstyle])
1535		1391
1536	Return and optionally change the current rendition. Text that is output by	1392	Return and optionally change the current rendition. Text that is output by
1537	the terminal application will use this style.	1393	the terminal application will use this style.
…		…
1695		1551
1696	=item $term->scr_add_lines ($string)	1552	=item $term->scr_add_lines ($string)
1697		1553
1698	Write the given text string to the screen, as if output by the application	1554	Write the given text string to the screen, as if output by the application
1699	running inside the terminal. It may not contain command sequences (escape	1555	running inside the terminal. It may not contain command sequences (escape
1700	codes), but is free to use line feeds, carriage returns and tabs. The	1556	codes - see C<cmd_parse> for that), but is free to use line feeds,
1701	string is a normal text string, not in locale-dependent encoding.	1557	carriage returns and tabs. The string is a normal text string, not in
		1558	locale-dependent encoding.
1702		1559
1703	Normally its not a good idea to use this function, as programs might be	1560	Normally its not a good idea to use this function, as programs might be
1704	confused by changes in cursor position or scrolling. Its useful inside a	1561	confused by changes in cursor position or scrolling. Its useful inside a
1705	C<on_add_lines> hook, though.	1562	C<on_add_lines> hook, though.
1706		1563
…		…
1714	locale-specific encoding of the terminal and can contain command sequences	1571	locale-specific encoding of the terminal and can contain command sequences
1715	(escape codes) that will be interpreted.	1572	(escape codes) that will be interpreted.
1716		1573
1717	=item $term->tt_write ($octets)	1574	=item $term->tt_write ($octets)
1718		1575
1719	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1576	Write the octets given in C<$octets> to the tty (i.e. as user input
		1577	to the program, see C<cmd_parse> for the opposite direction). To pass
1720	pass characters instead of octets, you should convert your strings first	1578	characters instead of octets, you should convert your strings first to the
1721	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_write_user_input ($octets)
		1582
		1583	Like C<tt_write>, but should be used when writing strings in response to
		1584	the user pressing a key, to invoke the additional actions requested by
		1585	the user for that case (C<tt_write> doesn't do that).
		1586
		1587	The typical use case would be inside C<on_action> hooks.
1722		1588
1723	=item $term->tt_paste ($octets)	1589	=item $term->tt_paste ($octets)
1724		1590
1725	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1591	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1726	CR and bracketing the data with control sequences if bracketed paste mode	1592	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1765		1631
1766	=item $term->key_release ($state, $keycode[, $time])	1632	=item $term->key_release ($state, $keycode[, $time])
1767		1633
1768	Deliver various fake events to to terminal.	1634	Deliver various fake events to to terminal.
1769		1635
1770	=item $window_width = $term->width	1636	=item $window_width = $term->width ([$new_value])
1771		1637
1772	=item $window_height = $term->height	1638	=item $window_height = $term->height ([$new_value])
1773		1639
1774	=item $font_width = $term->fwidth	1640	=item $font_width = $term->fwidth ([$new_value])
1775		1641
1776	=item $font_height = $term->fheight	1642	=item $font_height = $term->fheight ([$new_value])
1777		1643
1778	=item $font_ascent = $term->fbase	1644	=item $font_ascent = $term->fbase ([$new_value])
1779		1645
1780	=item $terminal_rows = $term->nrow	1646	=item $terminal_rows = $term->nrow ([$new_value])
1781		1647
1782	=item $terminal_columns = $term->ncol	1648	=item $terminal_columns = $term->ncol ([$new_value])
1783		1649
1784	=item $has_focus = $term->focus	1650	=item $has_focus = $term->focus ([$new_value])
1785		1651
1786	=item $is_mapped = $term->mapped	1652	=item $is_mapped = $term->mapped ([$new_value])
1787		1653
1788	=item $max_scrollback = $term->saveLines	1654	=item $max_scrollback = $term->saveLines ([$new_value])
1789		1655
1790	=item $nrow_plus_saveLines = $term->total_rows	1656	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1791		1657
1792	=item $topmost_scrollback_row = $term->top_row	1658	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1793		1659
1794	Return various integers describing terminal characteristics.	1660	Return various integers describing terminal characteristics. If an
		1661	argument is given, changes the value and returns the previous one.
1795		1662
1796	=item $x_display = $term->display_id	1663	=item $x_display = $term->display_id
1797		1664
1798	Return the DISPLAY used by rxvt-unicode.	1665	Return the DISPLAY used by rxvt-unicode.
1799		1666
…		…
1835	Returns the currently displayed screen (0 primary, 1 secondary).	1702	Returns the currently displayed screen (0 primary, 1 secondary).
1836		1703
1837	=item $cursor_is_hidden = $term->hidden_cursor	1704	=item $cursor_is_hidden = $term->hidden_cursor
1838		1705
1839	Returns whether the cursor is currently hidden or not.	1706	Returns whether the cursor is currently hidden or not.
		1707
		1708	=item $priv_modes = $term->priv_modes
		1709
		1710	Returns a bitset with the state of DEC private modes.
		1711
		1712	Example:
		1713
		1714	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1715	# mouse reporting is turned on
		1716	}
1840		1717
1841	=item $view_start = $term->view_start ([$newvalue])	1718	=item $view_start = $term->view_start ([$newvalue])
1842		1719
1843	Returns the row number of the topmost displayed line. Maximum value is	1720	Returns the row number of the topmost displayed line. Maximum value is
1844	C<0>, which displays the normal terminal contents. Lower values scroll	1721	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1849	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1726	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1850	compare the on-screen display with its stored representation. If they	1727	compare the on-screen display with its stored representation. If they
1851	differ, it redraws the differences.	1728	differ, it redraws the differences.
1852		1729
1853	Used after changing terminal contents to display them.	1730	Used after changing terminal contents to display them.
		1731
		1732	=item $term->refresh_check
		1733
		1734	Checks if a refresh has been requested and, if so, schedules one.
1854		1735
1855	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1736	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1856		1737
1857	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1738	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1858	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1739	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1960	}	1841	}
1961		1842
1962	sub urxvt::line::t {	1843	sub urxvt::line::t {
1963	my ($self) = @_;	1844	my ($self) = @_;
1964		1845
1965	if (@_ > 1)	1846	if (@_ > 1) {
1966	{
1967	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1847	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1968	for $self->{beg} .. $self->{end};	1848	for $self->{beg} .. $self->{end};
1969	}	1849	}
1970		1850
1971	defined wantarray &&	1851	defined wantarray &&
1972	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1852	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1973	0, $self->{len}	1853	0, $self->{len}
1974	}	1854	}
1975		1855
1976	sub urxvt::line::r {	1856	sub urxvt::line::r {
1977	my ($self) = @_;	1857	my ($self) = @_;
1978		1858
1979	if (@_ > 1)	1859	if (@_ > 1) {
1980	{
1981	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1860	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1982	for $self->{beg} .. $self->{end};	1861	for $self->{beg} .. $self->{end};
1983	}	1862	}
1984		1863
1985	if (defined wantarray) {	1864	if (defined wantarray) {
1986	my $rend = [	1865	my $rend = [
1987	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1866	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1988	];	1867	];

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.212 by root, Wed Jun 6 15:06:41 2012 UTC vs. Revision 1.257 by root, Thu Jul 13 10:31:27 2017 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.212 by root, Wed Jun 6 15:06:41 2012 UTC vs.
Revision 1.257 by root, Thu Jul 13 10:31:27 2017 UTC