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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.211 by root, Wed Jun 6 14:34:03 2012 UTC vs.
Revision 1.246 by root, Fri Dec 26 18:58:19 2014 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 and also default bindings for one or
50		51	more actions it provides using so called META comments, described
51	(More) intelligent selection. This extension tries to be more intelligent	52	below. Similarly to builtin resources, extension resources can also be
52	when the user extends selections (double-click and further clicks). Right	53	specified on the command line as long options (with C<.> replaced by
53	now, it tries to select words, urls and complete shell-quoted	54	C<->), in which case the corresponding extension is loaded
54	arguments, which is very convenient, too, if your F<ls> supports	55	automatically. For this to work the extension B<must> define META
55	C<--quoting-style=shell>.	56	comments for its resources.
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		57
415	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
416		59
417	=head2 General API Considerations	60	=head2 General API Considerations
418		61
467	internal use.	110	internal use.
468		111
469	Although it isn't a C<urxvt::term> object, you can call all methods of the	112	Although it isn't a C<urxvt::term> object, you can call all methods of the
470	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
471		114
472	It has the following methods and data members:	115	Additional methods only supported for extension objects are described in
		116	the C<urxvt::extension> section below.
		117
		118	=head2 META comments
		119
		120	rxvt-unicode recognizes special comments in extensions that define
		121	different types of metadata:
473		122
474	=over 4	123	=over 4
475		124
476	=item $urxvt_term = $self->{term}	125	=item #:META:RESOURCE:name:type:desc
477		126
478	Returns the C<urxvt::term> object associated with this instance of the	127	The RESOURCE comment defines a resource used by the extension, where
479	extension. This member I<must not> be changed in any way.	128	C<name> is the resource name, C<type> is the resource type, C<boolean>
		129	or C<string>, and C<desc> is the resource description.
480		130
481	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	131	=item #:META:BINDING:sym:action
482		132
483	Dynamically enable the given hooks (named without the C<on_> prefix) for	133	The BINDING comment defines a default binding for an action provided
484	this extension, replacing any previous hook. This is useful when you want	134	by the extension, where C<sym> is the key combination that triggers
485	to overwrite time-critical hooks only temporarily.	135	the action, whose format is defined in the description of the
486		136	B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
487	=item $self->disable ($hook_name[, $hook_name..])	137	of the action method.
488
489	Dynamically disable the given hooks.
490		138
491	=back	139	=back
492		140
493	=head2 Hooks	141	=head2 Hooks
494		142
…		…
663		311
664	=item on_refresh_end $term	312	=item on_refresh_end $term
665		313
666	Called just after the screen gets redrawn. See C<on_refresh_begin>.	314	Called just after the screen gets redrawn. See C<on_refresh_begin>.
667		315
		316	=item on_action $term, $string
		317
		318	Called whenever an action is invoked for the corresponding extension
		319	(e.g. via a C<extension:string> builtin action bound to a key, see
		320	description of the B<keysym> resource in the urxvt(1) manpage). The
		321	event is simply the action string. Note that an action event is always
		322	associated to a single extension.
		323
668	=item on_user_command $term, $string	324	=item on_user_command $term, $string DEPRECATED
669		325
670	Called whenever a user-configured event is being activated (e.g. via	326	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>	327	a C<perl:string> action bound to a key, see description of the B<keysym>
672	resource in the @@RXVT_NAME@@(1) manpage).	328	resource in the urxvt(1) manpage).
673		329
674	The event is simply the action string. This interface is assumed to change	330	The event is simply the action string. This interface is going away in
675	slightly in the future.	331	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		332
684	=item on_resize_all_windows $term, $new_width, $new_height	333	=item on_resize_all_windows $term, $new_width, $new_height
685		334
686	Called just after the new window size has been calculated, but before	335	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	336	windows are actually being resized or hints are being set. If this hook
688	returns TRUE, setting of the window hints is being skipped.	337	returns a true value, setting of the window hints is being skipped.
689		338
690	=item on_x_event $term, $event	339	=item on_x_event $term, $event
691		340
692	Called on every X event received on the vt window (and possibly other	341	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	342	windows). Should only be used as a last resort. Most event structure
…		…
733	(real, not screen-based) row and column under the mouse cursor.	382	(real, not screen-based) row and column under the mouse cursor.
734		383
735	C<on_key_press> additionally receives the string rxvt-unicode would	384	C<on_key_press> additionally receives the string rxvt-unicode would
736	output, if any, in locale-specific encoding.	385	output, if any, in locale-specific encoding.
737		386
738	subwindow.
739
740	=item on_client_message $term, $event	387	=item on_client_message $term, $event
741		388
742	=item on_wm_protocols $term, $event	389	=item on_wm_protocols $term, $event
743		390
744	=item on_wm_delete_window $term, $event	391	=item on_wm_delete_window $term, $event
…		…
755	=cut	402	=cut
756		403
757	package urxvt;	404	package urxvt;
758		405
759	use utf8;	406	use utf8;
760	use strict;	407	use strict 'vars';
761	use Carp ();	408	use Carp ();
762	use Scalar::Util ();	409	use Scalar::Util ();
763	use List::Util ();	410	use List::Util ();
764		411
765	our $VERSION = 1;	412	our $VERSION = 1;
…		…
946	no warnings 'utf8';	593	no warnings 'utf8';
947		594
948	sub parse_resource {	595	sub parse_resource {
949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
950		597
951	$term->scan_meta;	598	$term->scan_extensions;
952		599
953	my $r = $term->{meta}{resource};	600	my $r = $term->{meta}{resource};
		601	keys %$r; # reset iterator
954	while (my ($pattern, $v) = each %$r) {	602	while (my ($k, $v) = each %$r) {
		603	my $pattern = $k;
955	$name =~ y/-/./ if $isarg;	604	$pattern =~ y/./-/ if $isarg;
956		605	my $prefix = $name;
957	if (	606	my $suffix;
958	$pattern =~ s/\*$//	607	if ($pattern =~ /\-$/) {
959	? $pattern eq substr $name, 0, length $pattern	608	$prefix = substr $name, 0, length $pattern;
960	: $pattern eq $name	609	$suffix = substr $name, length $pattern;
961	) {	610	}
		611	if ($pattern eq $prefix) {
962	$name = "$urxvt::RESCLASS.$name";	612	$name = "$urxvt::RESCLASS.$k$suffix";
963		613
964	push @TERM_EXT, $v->[0];	614	push @{ $term->{perl_ext_3} }, $v->[0];
965		615
966	if ($v->[1] eq "boolean") {	616	if ($v->[1] eq "boolean") {
967	$term->put_option_db ($name, $flag ? "true" : "false");	617	$term->put_option_db ($name, $flag ? "true" : "false");
968	return 1;	618	return 1;
969	} else {	619	} else {
…		…
977	}	627	}
978		628
979	sub usage {	629	sub usage {
980	my ($term, $usage_type) = @_;	630	my ($term, $usage_type) = @_;
981		631
982	$term->scan_meta;	632	$term->scan_extensions;
983		633
984	my $r = $term->{meta}{resource};	634	my $r = $term->{meta}{resource};
985		635
986	for my $pattern (sort keys %$r) {	636	for my $pattern (sort keys %$r) {
987	my ($ext, $type, $desc) = @{ $r->{$pattern} };	637	my ($ext, $type, $desc) = @{ $r->{$pattern} };
988		638
989	$desc .= " (-pe $ext)";	639	$desc .= " (-pe $ext)";
990		640
991	if ($usage_type == 1) {	641	if ($usage_type == 1) {
992	$pattern =~ y/./-/;	642	$pattern =~ y/./-/;
993	$pattern =~ s/\*/.../g;	643	$pattern =~ s/-$/-.../g;
994		644
995	if ($type eq "boolean") {	645	if ($type eq "boolean") {
996	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;	646	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
997	} else {	647	} else {
998	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;	648	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
999	}	649	}
1000	} else {	650	} else {
		651	$pattern =~ s/\.$/.*/g;
1001	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;	652	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
1002	}	653	}
1003	}	654	}
1004	}	655	}
1005		656
…		…
1022	$pkg =~ s/[^[:word:]]/_/g;	673	$pkg =~ s/[^[:word:]]/_/g;
1023	$pkg = "urxvt::ext::$pkg";	674	$pkg = "urxvt::ext::$pkg";
1024		675
1025	verbose 3, "loading extension '$path' into package '$pkg'";	676	verbose 3, "loading extension '$path' into package '$pkg'";
1026		677
		678	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		679
1027	open my $fh, "<:raw", $path	680	open my $fh, "<:raw", $path
1028	or die "$path: $!";	681	or die "$path: $!";
1029		682
1030	my $source =	683	my $source =
1031	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	684	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
1032	. "#line 1 \"$path\"\n{\n"	685	. "#line 1 \"$path\"\n{\n"
1033	. (do { local $/; <$fh> })	686	. (do { local $/; <$fh> })
1034	. "\n};\n1";	687	. "\n};\n1";
1035		688
1036	eval $source	689	eval $source
…		…
1045	# called by the rxvt core	698	# called by the rxvt core
1046	sub invoke {	699	sub invoke {
1047	local $TERM = shift;	700	local $TERM = shift;
1048	my $htype = shift;	701	my $htype = shift;
1049		702
1050	if ($htype == 0) { # INIT	703	if ($htype == HOOK_INIT) {
1051	my @dirs = $TERM->perl_libdirs;	704	my @dirs = $TERM->perl_libdirs;
		705
		706	$TERM->scan_extensions;
1052		707
1053	my %ext_arg;	708	my %ext_arg;
1054		709
1055	{	710	{
1056	my @init = @TERM_INIT;	711	my @init = @TERM_INIT;
…		…
1059	my @pkg = @TERM_EXT;	714	my @pkg = @TERM_EXT;
1060	@TERM_EXT = ();	715	@TERM_EXT = ();
1061	$TERM->register_package ($_) for @pkg;	716	$TERM->register_package ($_) for @pkg;
1062	}	717	}
1063		718
		719	for (
1064	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	720	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		721	@{ delete $TERM->{perl_ext_3} }
		722	) {
1065	if ($_ eq "default") {	723	if ($_ eq "default") {
		724
		725	$ext_arg{$_} = []
		726	for
1066	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	727	qw(selection option-popup selection-popup readline searchable-scrollback),
		728	map $_->[0], values %{ $TERM->{meta}{binding} };
		729
		730	for ($TERM->_keysym_resources) {
		731	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		732	next unless /^([A-Za-z0-9_\-]+):/;
		733
		734	my $ext = $1;
		735
		736	$ext_arg{$ext} = [];
		737	}
		738
1067	} elsif (/^-(.*)$/) {	739	} elsif (/^-(.*)$/) {
1068	delete $ext_arg{$1};	740	delete $ext_arg{$1};
		741
1069	} elsif (/^([^<]+)<(.*)>$/) {	742	} elsif (/^([^<]+)<(.*)>$/) {
1070	push @{ $ext_arg{$1} }, $2;	743	push @{ $ext_arg{$1} }, $2;
		744
1071	} else {	745	} else {
1072	$ext_arg{$_} \|\|= [];	746	$ext_arg{$_} \|\|= [];
		747	}
		748	}
		749
		750	# now register default key bindings
		751	for my $ext (sort keys %ext_arg) {
		752	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		753	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
1073	}	754	}
1074	}	755	}
1075		756
1076	for my $ext (sort keys %ext_arg) {	757	for my $ext (sort keys %ext_arg) {
1077	my @files = grep -f $_, map "$_/$ext", @dirs;	758	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
1091		772
1092	if (my $cb = $TERM->{_hook}[$htype]) {	773	if (my $cb = $TERM->{_hook}[$htype]) {
1093	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	774	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1094	if $verbosity >= 10;	775	if $verbosity >= 10;
1095		776
		777	if ($htype == HOOK_ACTION) {
		778	# this hook is only sent to the extension with the name
		779	# matching the first arg
		780	my $pkg = shift;
		781	$pkg =~ y/-/_/;
		782	$pkg = "urxvt::ext::$pkg";
		783
		784	$cb = $cb->{$pkg}
		785	or return undef; #TODO: maybe warn user?
		786
		787	$cb = { $pkg => $cb };
		788	}
		789
1096	for my $pkg (keys %$cb) {	790	for my $pkg (keys %$cb) {
1097	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	791	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
1098	$retval \|\|= $retval_;	792	$retval \|\|= $retval_;
1099		793
1100	if ($@) {	794	if ($@) {
1101	$TERM->ungrab; # better to lose the grab than the session	795	$TERM->ungrab; # better to lose the grab than the session
1102	warn $@;	796	warn $@;
…		…
1105		799
1106	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1107	if $verbosity >= 11;	801	if $verbosity >= 11;
1108	}	802	}
1109		803
1110	if ($htype == 1) { # DESTROY	804	if ($htype == HOOK_DESTROY) {
1111	# clear package objects	805	# clear package objects
1112	%$_ = () for values %{ $TERM->{_pkg} };	806	%$_ = () for values %{ $TERM->{_pkg} };
1113		807
1114	# clear package	808	# clear package
1115	%$TERM = ();	809	%$TERM = ();
…		…
1145	}	839	}
1146	}	840	}
1147	($mask, @color{qw(fg bg)}, \@failed)	841	($mask, @color{qw(fg bg)}, \@failed)
1148	}	842	}
1149		843
1150	# urxvt::term::extension
1151
1152	package urxvt::term::extension;	844	package urxvt::term::extension;
1153		845
1154	sub enable {	846	=head2 The C<urxvt::term::extension> class
1155	my ($self, %hook) = @_;
1156	my $pkg = $self->{_pkg};
1157		847
1158	while (my ($name, $cb) = each %hook) {	848	Each extension attached to a terminal object is represented by
1159	my $htype = $HOOKTYPE{uc $name};	849	a C<urxvt::term::extension> object.
1160	defined $htype
1161	or Carp::croak "unsupported hook type '$name'";
1162		850
1163	$self->set_should_invoke ($htype, +1)	851	You can use these objects, which are passed to all callbacks to store any
1164	unless exists $self->{term}{_hook}[$htype]{$pkg};	852	state related to the terminal and extension instance.
1165		853
1166	$self->{term}{_hook}[$htype]{$pkg} = $cb;	854	The methods (And data members) documented below can be called on extension
1167	}	855	objects, in addition to call methods documented for the <urxvt::term>
1168	}	856	class.
1169		857
1170	sub disable {	858	=over 4
1171	my ($self, @hook) = @_;
1172	my $pkg = $self->{_pkg};
1173		859
1174	for my $name (@hook) {	860	=item $urxvt_term = $self->{term}
1175	my $htype = $HOOKTYPE{uc $name};
1176	defined $htype
1177	or Carp::croak "unsupported hook type '$name'";
1178		861
1179	$self->set_should_invoke ($htype, -1)	862	Returns the C<urxvt::term> object associated with this instance of the
1180	if delete $self->{term}{_hook}[$htype]{$pkg};	863	extension. This member I<must not> be changed in any way.
1181	}	864
1182	}	865	=cut
1183		866
1184	our $AUTOLOAD;	867	our $AUTOLOAD;
1185		868
1186	sub AUTOLOAD {	869	sub AUTOLOAD {
1187	$AUTOLOAD =~ /:([^:]+)$/	870	$AUTOLOAD =~ /:([^:]+)$/
…		…
1200		883
1201	sub DESTROY {	884	sub DESTROY {
1202	# nop	885	# nop
1203	}	886	}
1204		887
1205	# urxvt::destroy_hook	888	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1206		889
1207	sub urxvt::destroy_hook::DESTROY {	890	sub urxvt::destroy_hook::DESTROY {
1208	${$_[0]}->();	891	${$_[0]}->();
1209	}	892	}
1210		893
1211	sub urxvt::destroy_hook(&) {	894	sub urxvt::destroy_hook(&) {
1212	bless \shift, urxvt::destroy_hook::	895	bless \shift, urxvt::destroy_hook::
1213	}	896	}
		897
		898	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		899
		900	Dynamically enable the given hooks (named without the C<on_> prefix) for
		901	this extension, replacing any hook previously installed via C<enable> in
		902	this extension.
		903
		904	This is useful when you want to overwrite time-critical hooks only
		905	temporarily.
		906
		907	To install additional callbacks for the same hook, you can use the C<on>
		908	method of the C<urxvt::term> class.
		909
		910	=item $self->disable ($hook_name[, $hook_name..])
		911
		912	Dynamically disable the given hooks.
		913
		914	=cut
		915
		916	sub enable {
		917	my ($self, %hook) = @_;
		918	my $pkg = $self->{_pkg};
		919
		920	while (my ($name, $cb) = each %hook) {
		921	my $htype = $HOOKTYPE{uc $name};
		922	defined $htype
		923	or Carp::croak "unsupported hook type '$name'";
		924
		925	$self->set_should_invoke ($htype, +1)
		926	unless exists $self->{term}{_hook}[$htype]{$pkg};
		927
		928	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		929	}
		930	}
		931
		932	sub disable {
		933	my ($self, @hook) = @_;
		934	my $pkg = $self->{_pkg};
		935
		936	for my $name (@hook) {
		937	my $htype = $HOOKTYPE{uc $name};
		938	defined $htype
		939	or Carp::croak "unsupported hook type '$name'";
		940
		941	$self->set_should_invoke ($htype, -1)
		942	if delete $self->{term}{_hook}[$htype]{$pkg};
		943	}
		944	}
		945
		946	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		947
		948	Similar to the C<enable> enable, but installs additional callbacks for
		949	the given hook(s) (that is, it doesn't replace existing callbacks), and
		950	returns a guard object. When the guard object is destroyed the callbacks
		951	are disabled again.
		952
		953	=cut
		954
		955	sub urxvt::extension::on_disable::DESTROY {
		956	my $disable = shift;
		957
		958	my $term = delete $disable->{""};
		959
		960	while (my ($htype, $id) = each %$disable) {
		961	delete $term->{_hook}[$htype]{$id};
		962	$term->set_should_invoke ($htype, -1);
		963	}
		964	}
		965
		966	sub on {
		967	my ($self, %hook) = @_;
		968
		969	my $term = $self->{term};
		970
		971	my %disable = ( "" => $term );
		972
		973	while (my ($name, $cb) = each %hook) {
		974	my $htype = $HOOKTYPE{uc $name};
		975	defined $htype
		976	or Carp::croak "unsupported hook type '$name'";
		977
		978	$term->set_should_invoke ($htype, +1);
		979	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		980	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		981	}
		982
		983	bless \%disable, "urxvt::extension::on_disable"
		984	}
		985
		986	=item $self->x_resource ($pattern)
		987
		988	=item $self->x_resource_boolean ($pattern)
		989
		990	These methods support an additional C<%> prefix when called on an
		991	extension object - see the description of these methods in the
		992	C<urxvt::term> class for details.
		993
		994	=cut
		995
		996	sub x_resource {
		997	my ($self, $name) = @_;
		998	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		999	$self->{term}->x_resource ($name)
		1000	}
		1001
		1002	sub x_resource_boolean {
		1003	my ($self, $name) = @_;
		1004	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		1005	$self->{term}->x_resource_boolean ($name)
		1006	}
		1007
		1008	=back
		1009
		1010	=cut
1214		1011
1215	package urxvt::anyevent;	1012	package urxvt::anyevent;
1216		1013
1217	=head2 The C<urxvt::anyevent> Class	1014	=head2 The C<urxvt::anyevent> Class
1218		1015
…		…
1314	urxvt::verbose 6, "register package $pkg to $self";	1111	urxvt::verbose 6, "register package $pkg to $self";
1315		1112
1316	@{"$pkg\::ISA"} = urxvt::term::extension::;	1113	@{"$pkg\::ISA"} = urxvt::term::extension::;
1317		1114
1318	my $proxy = bless {	1115	my $proxy = bless {
1319	_pkg => $pkg,	1116	_pkg => $pkg,
		1117	_name => ${"$pkg\::_NAME"}, # hackish
1320	argv => $argv,	1118	argv => $argv,
1321	}, $pkg;	1119	}, $pkg;
1322	Scalar::Util::weaken ($proxy->{term} = $self);	1120	Scalar::Util::weaken ($proxy->{term} = $self);
1323		1121
1324	$self->{_pkg}{$pkg} = $proxy;	1122	$self->{_pkg}{$pkg} = $proxy;
1325		1123
…		…
1336	$ENV{URXVT_PERL_LIB},	1134	$ENV{URXVT_PERL_LIB},
1337	"$ENV{HOME}/.urxvt/ext",	1135	"$ENV{HOME}/.urxvt/ext",
1338	"$LIBDIR/perl"	1136	"$LIBDIR/perl"
1339	}	1137	}
1340		1138
1341	sub scan_meta {	1139	# scan for available extensions and collect their metadata
		1140	sub scan_extensions {
1342	my ($self) = @_;	1141	my ($self) = @_;
		1142
		1143	return if exists $self->{meta};
		1144
1343	my @libdirs = perl_libdirs $self;	1145	my @libdirs = perl_libdirs $self;
1344		1146
1345	return if $self->{meta_libdirs} eq join "\x00", @libdirs;	1147	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1346		1148
1347	my %meta;
1348
1349	$self->{meta_libdirs} = join "\x00", @libdirs;	1149	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1350	$self->{meta} = \%meta;	1150	$self->{meta} = \my %meta;
1351		1151
		1152	# first gather extensions
1352	for my $dir (reverse @libdirs) {	1153	for my $dir (reverse @libdirs) {
1353	opendir my $fh, $dir	1154	opendir my $fh, $dir
1354	or next;	1155	or next;
1355	for my $ext (readdir $fh) {	1156	for my $ext (readdir $fh) {
1356	$ext ne "."	1157	$ext !~ /^\./
1357	and $ext ne ".."
1358	and open my $fh, "<", "$dir/$ext"	1158	and open my $fh, "<", "$dir/$ext"
1359	or next;	1159	or next;
1360		1160
		1161	my %ext = (dir => $dir);
		1162
1361	while (<$fh>) {	1163	while (<$fh>) {
1362	if (/^#:META:X_RESOURCE:(.*)/) {	1164	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1363	my ($pattern, $type, $desc) = split /:/, $1;	1165	my ($pattern, $type, $desc) = split /:/, $1;
1364	$pattern =~ s/^%\./$ext./g; # $$ in pattern == extension name	1166	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1365	if ($pattern =~ /[^a-zA-Z\*\.]/) {	1167	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1366	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1168	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1367	} else {	1169	} else {
1368	$meta{resource}{$pattern} = [$ext, $type, $desc];	1170	$ext{resource}{$pattern} = [$ext, $type, $desc];
1369	}	1171	}
		1172	} elsif (/^#:META:BINDING:(.*)/) {
		1173	my ($keysym, $action) = split /:/, $1;
		1174	$ext{binding}{$keysym} = [$ext, $action];
1370	} elsif (/^\s*(?:#\|$)/) {	1175	} elsif (/^\s*(?:#\|$)/) {
1371	# skip other comments and empty lines	1176	# skip other comments and empty lines
1372	} else {	1177	} else {
1373	last; # stop parsing on first non-empty non-comment line	1178	last; # stop parsing on first non-empty non-comment line
1374	}	1179	}
1375	}	1180	}
		1181
		1182	$meta{ext}{$ext} = \%ext;
1376	}	1183	}
		1184	}
		1185
		1186	# and now merge resources and bindings
		1187	while (my ($k, $v) = each %{ $meta{ext} }) {
		1188	#TODO: should check for extensions overriding each other
		1189	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1190	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1377	}	1191	}
1378	}	1192	}
1379		1193
1380	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1194	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1381		1195
…		…
1401	}	1215	}
1402		1216
1403	=item $term->destroy	1217	=item $term->destroy
1404		1218
1405	Destroy the terminal object (close the window, free resources	1219	Destroy the terminal object (close the window, free resources
1406	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1220	etc.). Please note that urxvt will not exit as long as any event
1407	watchers (timers, io watchers) are still active.	1221	watchers (timers, io watchers) are still active.
1408		1222
1409	=item $term->exec_async ($cmd[, @args])	1223	=item $term->exec_async ($cmd[, @args])
1410		1224
1411	Works like the combination of the C<fork>/C<exec> builtins, which executes	1225	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1467		1281
1468	Here is a likely non-exhaustive list of resource names, not all of which	1282	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>	1283	are supported in every build, please see the source file F</src/rsinc.h>
1470	to see the actual list:	1284	to see the actual list:
1471		1285
1472	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1286	answerbackstring backgroundPixmap backspace_key blurradius
1473	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1287	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1474	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1288	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1475	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1289	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1476	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1290	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1477	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1291	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1497	Returns the X-Resource for the given pattern, excluding the program or	1311	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	1312	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	1313	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1500	resource with that pattern exists.	1314	resource with that pattern exists.
1501		1315
		1316	Extensions that define extra resources also need to call this method
		1317	to access their values.
		1318
		1319	If the method is called on an extension object (basically, from an
		1320	extension), then the special prefix C<%.> will be replaced by the name of
		1321	the extension and a dot, and the lone string C<%> will be replaced by the
		1322	extension name itself. This makes it possible to code extensions so you
		1323	can rename them and get a new set of resources without having to change
		1324	the actual code.
		1325
1502	This method should only be called during the C<on_start> hook, as there is	1326	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	1327	only one resource database per display, and later invocations might return
1504	the wrong resources.	1328	the wrong resources.
1505		1329
1506	=item $value = $term->x_resource_boolean ($pattern)	1330	=item $value = $term->x_resource_boolean ($pattern)
…		…
1517	my $res = &x_resource;	1341	my $res = &x_resource;
1518		1342
1519	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1343	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1520	}	1344	}
1521		1345
1522	=item $success = $term->parse_keysym ($key, $octets)	1346	=item $success = $term->bind_action ($key, $octets)
1523		1347
1524	Adds a key binding exactly as specified via a resource. See the	1348	Adds a key binding exactly as specified via a C<keysym> resource. See the
1525	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1349	C<keysym> resource in the urxvt(1) manpage.
1526
1527	=item $term->register_command ($keysym, $modifiermask, $string)
1528
1529	Adds a key binding. This is a lower level api compared to
1530	C<parse_keysym>, as it expects a parsed key description, and can be
1531	used only inside either the C<on_init> hook, to add a binding, or the
1532	C<on_register_command> hook, to modify a parsed binding.
1533		1350
1534	=item $rend = $term->rstyle ([$new_rstyle])	1351	=item $rend = $term->rstyle ([$new_rstyle])
1535		1352
1536	Return and optionally change the current rendition. Text that is output by	1353	Return and optionally change the current rendition. Text that is output by
1537	the terminal application will use this style.	1354	the terminal application will use this style.
…		…
1695		1512
1696	=item $term->scr_add_lines ($string)	1513	=item $term->scr_add_lines ($string)
1697		1514
1698	Write the given text string to the screen, as if output by the application	1515	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	1516	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	1517	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.	1518	carriage returns and tabs. The string is a normal text string, not in
		1519	locale-dependent encoding.
1702		1520
1703	Normally its not a good idea to use this function, as programs might be	1521	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	1522	confused by changes in cursor position or scrolling. Its useful inside a
1705	C<on_add_lines> hook, though.	1523	C<on_add_lines> hook, though.
1706		1524
…		…
1714	locale-specific encoding of the terminal and can contain command sequences	1532	locale-specific encoding of the terminal and can contain command sequences
1715	(escape codes) that will be interpreted.	1533	(escape codes) that will be interpreted.
1716		1534
1717	=item $term->tt_write ($octets)	1535	=item $term->tt_write ($octets)
1718		1536
1719	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1537	Write the octets given in C<$octets> to the tty (i.e. as user input
		1538	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	1539	characters instead of octets, you should convert your strings first to the
1721	to the locale-specific encoding using C<< $term->locale_encode >>.	1540	locale-specific encoding using C<< $term->locale_encode >>.
		1541
		1542	=item $term->tt_write_user_input ($octets)
		1543
		1544	Like C<tt_write>, but should be used when writing strings in response to
		1545	the user pressing a key, to invoke the additional actions requested by
		1546	the user for that case (C<tt_write> doesn't do that).
		1547
		1548	The typical use case would be inside C<on_action> hooks.
1722		1549
1723	=item $term->tt_paste ($octets)	1550	=item $term->tt_paste ($octets)
1724		1551
1725	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1552	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	1553	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1960	}	1787	}
1961		1788
1962	sub urxvt::line::t {	1789	sub urxvt::line::t {
1963	my ($self) = @_;	1790	my ($self) = @_;
1964		1791
1965	if (@_ > 1)	1792	if (@_ > 1) {
1966	{
1967	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1793	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1968	for $self->{beg} .. $self->{end};	1794	for $self->{beg} .. $self->{end};
1969	}	1795	}
1970		1796
1971	defined wantarray &&	1797	defined wantarray &&
1972	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1798	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1973	0, $self->{len}	1799	0, $self->{len}
1974	}	1800	}
1975		1801
1976	sub urxvt::line::r {	1802	sub urxvt::line::r {
1977	my ($self) = @_;	1803	my ($self) = @_;
1978		1804
1979	if (@_ > 1)	1805	if (@_ > 1) {
1980	{
1981	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1806	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1982	for $self->{beg} .. $self->{end};	1807	for $self->{beg} .. $self->{end};
1983	}	1808	}
1984		1809
1985	if (defined wantarray) {	1810	if (defined wantarray) {
1986	my $rend = [	1811	my $rend = [
1987	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1812	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1988	];	1813	];

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.211 by root, Wed Jun 6 14:34:03 2012 UTC vs. Revision 1.246 by root, Fri Dec 26 18:58:19 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.211 by root, Wed Jun 6 14:34:03 2012 UTC vs.
Revision 1.246 by root, Fri Dec 26 18:58:19 2014 UTC