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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC vs.
Revision 1.249 by root, Fri Dec 26 21:26:37 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 from the keyboard.
265	Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267	Example configuration:
268
269	URxvt.perl-ext: default,matcher
270	URxvt.urlLauncher: sensible-browser
271	URxvt.keysym.C-Delete: perl:matcher
272	URxvt.matcher.button: 1
273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
275	URxvt.matcher.launcher.2: gvim +$2 $1
276
277	=item xim-onthespot
278
279	This (experimental) perl extension implements OnTheSpot editing. It does
280	not work perfectly, and some input methods don't seem to work well with
281	OnTheSpot editing in general, but it seems to work at least for SCIM and
282	kinput2.
283
284	You enable it by specifying this extension and a preedit style of
285	C<OnTheSpot>, i.e.:
286
287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
288
289	=item kuake<hotkey>
290
291	A very primitive quake-console-like extension. It was inspired by a
292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
293	user presses a global accelerator key (by default C<F10>), the terminal
294	will show or hide itself. Another press of the accelerator key will hide
295	or show it again.
296
297	Initially, the window will not be shown when using this extension.
298
299	This is useful if you need a single terminal that is not using any desktop
300	space most of the time but is quickly available at the press of a key.
301
302	The accelerator key is grabbed regardless of any modifiers, so this
303	extension will actually grab a physical key just for this function.
304
305	If you want a quake-like animation, tell your window manager to do so
306	(fvwm can do it).
307
308	=item overlay-osc
309
310	This extension implements some OSC commands to display timed popups on the
311	screen - useful for status displays from within scripts. You have to read
312	the sources for more info.
313
314	=item block-graphics-to-ascii
315
316	A not very useful example of filtering all text output to the terminal
317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
318	similar-looking ascii character.
319
320	=item digital-clock
321
322	Displays a digital clock using the built-in overlay.
323
324	=item remote-clipboard
325
326	Somewhat of a misnomer, this extension adds two menu entries to the
327	selection popup that allows one to run external commands to store the
328	selection somewhere and fetch it again.
329
330	We use it to implement a "distributed selection mechanism", which just
331	means that one command uploads the file to a remote server, and another
332	reads it.
333
334	The commands can be set using the C<URxvt.remote-selection.store> and
335	C<URxvt.remote-selection.fetch> resources. The first should read the
336	selection to store from STDIN (always in UTF-8), the second should provide
337	the selection data on STDOUT (also in UTF-8).
338
339	The defaults (which are likely useless to you) use rsh and cat:
340
341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343
344	=item selection-pastebin
345
346	This is a little rarely useful extension that uploads the selection as
347	textfile to a remote site (or does other things). (The implementation is
348	not currently secure for use in a multiuser environment as it writes to
349	F</tmp> directly.).
350
351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
352	i.e.
353
354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
355
356	Pressing this combination runs a command with C<%> replaced by the name of
357	the textfile. This command can be set via a resource:
358
359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
360
361	And the default is likely not useful to anybody but the few people around
362	here :)
363
364	The name of the textfile is the hex encoded md5 sum of the selection, so
365	the same content should lead to the same filename.
366
367	After a successful upload the selection will be replaced by the text given
368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
369	for the filename):
370
371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372
373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374	the double C</> characters as comment start. Use C<\057\057> instead,
375	which works regardless of whether xrdb is used to parse the resource file
376	or not.
377
378	=item macosx-clipboard and macosx-clipboard-native
379
380	These two modules implement an extended clipboard for Mac OS X. They are
381	used like this:
382
383	URxvt.perl-ext-common: default,macosx-clipboard
384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
386
387	The difference between them is that the native variant requires a
388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390	simpler etc. etc.
391
392	=item example-refresh-hooks
393
394	Displays a very simple digital clock in the upper right corner of the
395	window. Illustrates overwriting the refresh callbacks to create your own
396	overlays or changes.
397
398	=item confirm-paste
399
400	Displays a confirmation dialog when a paste containing at least a full
401	line is detected.
402
403	=back
404		57
405	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
406		59
407	=head2 General API Considerations	60	=head2 General API Considerations
408		61
435		88
436	=item $octets	89	=item $octets
437		90
438	Either binary data or - more common - a text string encoded in a	91	Either binary data or - more common - a text string encoded in a
439	locale-specific way.	92	locale-specific way.
		93
		94	=item $keysym
		95
		96	an integer that is a valid X11 keysym code. You can convert a string
		97	into a keysym and viceversa by using C<XStringToKeysym> and
		98	C<XKeysymToString>.
440		99
441	=back	100	=back
442		101
443	=head2 Extension Objects	102	=head2 Extension Objects
444		103
…		…
451	internal use.	110	internal use.
452		111
453	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
454	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
455		114
456	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 meta comments in extensions that define
		121	different types of metadata.
		122
		123	Currently, it recxognises only one such comment:
457		124
458	=over 4	125	=over 4
459		126
460	=item $urxvt_term = $self->{term}	127	=item #:META:RESOURCE:name:type:desc
461		128
462	Returns the C<urxvt::term> object associated with this instance of the	129	The RESOURCE comment defines a resource used by the extension, where
463	extension. This member I<must not> be changed in any way.	130	C<name> is the resource name, C<type> is the resource type, C<boolean>
464		131	or C<string>, and C<desc> is the resource description.
465	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
466
467	Dynamically enable the given hooks (named without the C<on_> prefix) for
468	this extension, replacing any previous hook. This is useful when you want
469	to overwrite time-critical hooks only temporarily.
470
471	=item $self->disable ($hook_name[, $hook_name..])
472
473	Dynamically disable the given hooks.
474		132
475	=back	133	=back
476		134
477	=head2 Hooks	135	=head2 Hooks
478		136
…		…
647		305
648	=item on_refresh_end $term	306	=item on_refresh_end $term
649		307
650	Called just after the screen gets redrawn. See C<on_refresh_begin>.	308	Called just after the screen gets redrawn. See C<on_refresh_begin>.
651		309
		310	=item on_action $term, $string
		311
		312	Called whenever an action is invoked for the corresponding extension
		313	(e.g. via a C<extension:string> builtin action bound to a key, see
		314	description of the B<keysym> resource in the urxvt(1) manpage). The
		315	event is simply the action string. Note that an action event is always
		316	associated to a single extension.
		317
652	=item on_user_command $term, $string	318	=item on_user_command $term, $string DEPRECATED
653		319
654	Called whenever a user-configured event is being activated (e.g. via	320	Called whenever a user-configured event is being activated (e.g. via
655	a C<perl:string> action bound to a key, see description of the B<keysym>	321	a C<perl:string> action bound to a key, see description of the B<keysym>
656	resource in the @@RXVT_NAME@@(1) manpage).	322	resource in the urxvt(1) manpage).
657		323
658	The event is simply the action string. This interface is assumed to change	324	The event is simply the action string. This interface is going away in
659	slightly in the future.	325	preference to the C<on_action> hook.
660		326
661	=item on_resize_all_windows $term, $new_width, $new_height	327	=item on_resize_all_windows $term, $new_width, $new_height
662		328
663	Called just after the new window size has been calculated, but before	329	Called just after the new window size has been calculated, but before
664	windows are actually being resized or hints are being set. If this hook	330	windows are actually being resized or hints are being set. If this hook
665	returns TRUE, setting of the window hints is being skipped.	331	returns a true value, setting of the window hints is being skipped.
666		332
667	=item on_x_event $term, $event	333	=item on_x_event $term, $event
668		334
669	Called on every X event received on the vt window (and possibly other	335	Called on every X event received on the vt window (and possibly other
670	windows). Should only be used as a last resort. Most event structure	336	windows). Should only be used as a last resort. Most event structure
…		…
710	(real, not screen-based) row and column under the mouse cursor.	376	(real, not screen-based) row and column under the mouse cursor.
711		377
712	C<on_key_press> additionally receives the string rxvt-unicode would	378	C<on_key_press> additionally receives the string rxvt-unicode would
713	output, if any, in locale-specific encoding.	379	output, if any, in locale-specific encoding.
714		380
715	subwindow.
716
717	=item on_client_message $term, $event	381	=item on_client_message $term, $event
718		382
719	=item on_wm_protocols $term, $event	383	=item on_wm_protocols $term, $event
720		384
721	=item on_wm_delete_window $term, $event	385	=item on_wm_delete_window $term, $event
…		…
732	=cut	396	=cut
733		397
734	package urxvt;	398	package urxvt;
735		399
736	use utf8;	400	use utf8;
737	use strict;	401	use strict 'vars';
738	use Carp ();	402	use Carp ();
739	use Scalar::Util ();	403	use Scalar::Util ();
740	use List::Util ();	404	use List::Util ();
741		405
742	our $VERSION = 1;	406	our $VERSION = 1;
743	our $TERM;	407	our $TERM;
744	our @TERM_INIT;	408	our @TERM_INIT; # should go, prevents async I/O etc.
745	our @TERM_EXT;	409	our @TERM_EXT; # should go, prevents async I/O etc.
746	our @HOOKNAME;	410	our @HOOKNAME;
747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	411	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
748	our %OPTION;	412	our %OPTION;
749		413
750	our $LIBDIR;	414	our $LIBDIR;
…		…
920	};	584	};
921	}	585	}
922		586
923	no warnings 'utf8';	587	no warnings 'utf8';
924		588
		589	sub parse_resource {
		590	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		591
		592	$term->scan_extensions;
		593
		594	my $r = $term->{meta}{resource};
		595	keys %$r; # reset iterator
		596	while (my ($k, $v) = each %$r) {
		597	my $pattern = $k;
		598	$pattern =~ y/./-/ if $isarg;
		599	my $prefix = $name;
		600	my $suffix;
		601	if ($pattern =~ /\-$/) {
		602	$prefix = substr $name, 0, length $pattern;
		603	$suffix = substr $name, length $pattern;
		604	}
		605	if ($pattern eq $prefix) {
		606	$name = "$urxvt::RESCLASS.$k$suffix";
		607
		608	push @{ $term->{perl_ext_3} }, $v->[0];
		609
		610	if ($v->[1] eq "boolean") {
		611	$term->put_option_db ($name, $flag ? "true" : "false");
		612	return 1;
		613	} else {
		614	$term->put_option_db ($name, $value);
		615	return 1 + 2;
		616	}
		617	}
		618	}
		619
		620	0
		621	}
		622
		623	sub usage {
		624	my ($term, $usage_type) = @_;
		625
		626	$term->scan_extensions;
		627
		628	my $r = $term->{meta}{resource};
		629
		630	for my $pattern (sort keys %$r) {
		631	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		632
		633	$desc .= " (-pe $ext)";
		634
		635	if ($usage_type == 1) {
		636	$pattern =~ y/./-/;
		637	$pattern =~ s/-$/-.../g;
		638
		639	if ($type eq "boolean") {
		640	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		641	} else {
		642	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		643	}
		644	} else {
		645	$pattern =~ s/\.$/.*/g;
		646	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		647	}
		648	}
		649	}
		650
925	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
926		652
927	sub verbose {	653	sub verbose {
928	my ($level, $msg) = @_;	654	my ($level, $msg) = @_;
929	warn "$msg\n" if $level <= $verbosity;	655	warn "$msg\n" if $level <= $verbosity;
…		…
941	$pkg =~ s/[^[:word:]]/_/g;	667	$pkg =~ s/[^[:word:]]/_/g;
942	$pkg = "urxvt::ext::$pkg";	668	$pkg = "urxvt::ext::$pkg";
943		669
944	verbose 3, "loading extension '$path' into package '$pkg'";	670	verbose 3, "loading extension '$path' into package '$pkg'";
945		671
		672	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		673
946	open my $fh, "<:raw", $path	674	open my $fh, "<:raw", $path
947	or die "$path: $!";	675	or die "$path: $!";
948		676
949	my $source =	677	my $source =
950	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	678	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
951	. "#line 1 \"$path\"\n{\n"	679	. "#line 1 \"$path\"\n{\n"
952	. (do { local $/; <$fh> })	680	. (do { local $/; <$fh> })
953	. "\n};\n1";	681	. "\n};\n1";
954		682
955	eval $source	683	eval $source
…		…
964	# called by the rxvt core	692	# called by the rxvt core
965	sub invoke {	693	sub invoke {
966	local $TERM = shift;	694	local $TERM = shift;
967	my $htype = shift;	695	my $htype = shift;
968		696
969	if ($htype == 0) { # INIT	697	if ($htype == HOOK_INIT) {
970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	698	my @dirs = $TERM->perl_libdirs;
		699
		700	$TERM->scan_extensions;
971		701
972	my %ext_arg;	702	my %ext_arg;
973		703
974	{	704	{
975	my @init = @TERM_INIT;	705	my @init = @TERM_INIT;
…		…
978	my @pkg = @TERM_EXT;	708	my @pkg = @TERM_EXT;
979	@TERM_EXT = ();	709	@TERM_EXT = ();
980	$TERM->register_package ($_) for @pkg;	710	$TERM->register_package ($_) for @pkg;
981	}	711	}
982		712
		713	for (
983	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	714	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		715	@{ delete $TERM->{perl_ext_3} }
		716	) {
984	if ($_ eq "default") {	717	if ($_ eq "default") {
		718
		719	$ext_arg{$_} = []
985	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	720	for qw(selection option-popup selection-popup readline searchable-scrollback);
		721
		722	for ($TERM->_keysym_resources) {
		723	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		724	next unless /^([A-Za-z0-9_\-]+):/;
		725
		726	my $ext = $1;
		727
		728	$ext_arg{$ext} = [];
		729	}
		730
986	} elsif (/^-(.*)$/) {	731	} elsif (/^-(.*)$/) {
987	delete $ext_arg{$1};	732	delete $ext_arg{$1};
		733
988	} elsif (/^([^<]+)<(.*)>$/) {	734	} elsif (/^([^<]+)<(.*)>$/) {
989	push @{ $ext_arg{$1} }, $2;	735	push @{ $ext_arg{$1} }, $2;
		736
990	} else {	737	} else {
991	$ext_arg{$_} \|\|= [];	738	$ext_arg{$_} \|\|= [];
992	}	739	}
993	}	740	}
994		741
…		…
1010		757
1011	if (my $cb = $TERM->{_hook}[$htype]) {	758	if (my $cb = $TERM->{_hook}[$htype]) {
1012	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	759	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1013	if $verbosity >= 10;	760	if $verbosity >= 10;
1014		761
		762	if ($htype == HOOK_ACTION) {
		763	# this hook is only sent to the extension with the name
		764	# matching the first arg
		765	my $pkg = shift;
		766	$pkg =~ y/-/_/;
		767	$pkg = "urxvt::ext::$pkg";
		768
		769	$cb = $cb->{$pkg}
		770	or return undef; #TODO: maybe warn user?
		771
		772	$cb = { $pkg => $cb };
		773	}
		774
1015	for my $pkg (keys %$cb) {	775	for my $pkg (keys %$cb) {
1016	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	776	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
1017	$retval \|\|= $retval_;	777	$retval \|\|= $retval_;
1018		778
1019	if ($@) {	779	if ($@) {
1020	$TERM->ungrab; # better to lose the grab than the session	780	$TERM->ungrab; # better to lose the grab than the session
1021	warn $@;	781	warn $@;
…		…
1024		784
1025	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	785	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1026	if $verbosity >= 11;	786	if $verbosity >= 11;
1027	}	787	}
1028		788
1029	if ($htype == 1) { # DESTROY	789	if ($htype == HOOK_DESTROY) {
1030	# clear package objects	790	# clear package objects
1031	%$_ = () for values %{ $TERM->{_pkg} };	791	%$_ = () for values %{ $TERM->{_pkg} };
1032		792
1033	# clear package	793	# clear package
1034	%$TERM = ();	794	%$TERM = ();
…		…
1064	}	824	}
1065	}	825	}
1066	($mask, @color{qw(fg bg)}, \@failed)	826	($mask, @color{qw(fg bg)}, \@failed)
1067	}	827	}
1068		828
1069	# urxvt::term::extension
1070
1071	package urxvt::term::extension;	829	package urxvt::term::extension;
1072		830
1073	sub enable {	831	=head2 The C<urxvt::term::extension> class
1074	my ($self, %hook) = @_;
1075	my $pkg = $self->{_pkg};
1076		832
1077	while (my ($name, $cb) = each %hook) {	833	Each extension attached to a terminal object is represented by
1078	my $htype = $HOOKTYPE{uc $name};	834	a C<urxvt::term::extension> object.
1079	defined $htype
1080	or Carp::croak "unsupported hook type '$name'";
1081		835
1082	$self->set_should_invoke ($htype, +1)	836	You can use these objects, which are passed to all callbacks to store any
1083	unless exists $self->{term}{_hook}[$htype]{$pkg};	837	state related to the terminal and extension instance.
1084		838
1085	$self->{term}{_hook}[$htype]{$pkg} = $cb;	839	The methods (And data members) documented below can be called on extension
1086	}	840	objects, in addition to call methods documented for the <urxvt::term>
1087	}	841	class.
1088		842
1089	sub disable {	843	=over 4
1090	my ($self, @hook) = @_;
1091	my $pkg = $self->{_pkg};
1092		844
1093	for my $name (@hook) {	845	=item $urxvt_term = $self->{term}
1094	my $htype = $HOOKTYPE{uc $name};
1095	defined $htype
1096	or Carp::croak "unsupported hook type '$name'";
1097		846
1098	$self->set_should_invoke ($htype, -1)	847	Returns the C<urxvt::term> object associated with this instance of the
1099	if delete $self->{term}{_hook}[$htype]{$pkg};	848	extension. This member I<must not> be changed in any way.
1100	}	849
1101	}	850	=cut
1102		851
1103	our $AUTOLOAD;	852	our $AUTOLOAD;
1104		853
1105	sub AUTOLOAD {	854	sub AUTOLOAD {
1106	$AUTOLOAD =~ /:([^:]+)$/	855	$AUTOLOAD =~ /:([^:]+)$/
…		…
1119		868
1120	sub DESTROY {	869	sub DESTROY {
1121	# nop	870	# nop
1122	}	871	}
1123		872
1124	# urxvt::destroy_hook	873	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1125		874
1126	sub urxvt::destroy_hook::DESTROY {	875	sub urxvt::destroy_hook::DESTROY {
1127	${$_[0]}->();	876	${$_[0]}->();
1128	}	877	}
1129		878
1130	sub urxvt::destroy_hook(&) {	879	sub urxvt::destroy_hook(&) {
1131	bless \shift, urxvt::destroy_hook::	880	bless \shift, urxvt::destroy_hook::
1132	}	881	}
		882
		883	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		884
		885	Dynamically enable the given hooks (named without the C<on_> prefix) for
		886	this extension, replacing any hook previously installed via C<enable> in
		887	this extension.
		888
		889	This is useful when you want to overwrite time-critical hooks only
		890	temporarily.
		891
		892	To install additional callbacks for the same hook, you can use the C<on>
		893	method of the C<urxvt::term> class.
		894
		895	=item $self->disable ($hook_name[, $hook_name..])
		896
		897	Dynamically disable the given hooks.
		898
		899	=cut
		900
		901	sub enable {
		902	my ($self, %hook) = @_;
		903	my $pkg = $self->{_pkg};
		904
		905	while (my ($name, $cb) = each %hook) {
		906	my $htype = $HOOKTYPE{uc $name};
		907	defined $htype
		908	or Carp::croak "unsupported hook type '$name'";
		909
		910	$self->set_should_invoke ($htype, +1)
		911	unless exists $self->{term}{_hook}[$htype]{$pkg};
		912
		913	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		914	}
		915	}
		916
		917	sub disable {
		918	my ($self, @hook) = @_;
		919	my $pkg = $self->{_pkg};
		920
		921	for my $name (@hook) {
		922	my $htype = $HOOKTYPE{uc $name};
		923	defined $htype
		924	or Carp::croak "unsupported hook type '$name'";
		925
		926	$self->set_should_invoke ($htype, -1)
		927	if delete $self->{term}{_hook}[$htype]{$pkg};
		928	}
		929	}
		930
		931	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		932
		933	Similar to the C<enable> enable, but installs additional callbacks for
		934	the given hook(s) (that is, it doesn't replace existing callbacks), and
		935	returns a guard object. When the guard object is destroyed the callbacks
		936	are disabled again.
		937
		938	=cut
		939
		940	sub urxvt::extension::on_disable::DESTROY {
		941	my $disable = shift;
		942
		943	my $term = delete $disable->{""};
		944
		945	while (my ($htype, $id) = each %$disable) {
		946	delete $term->{_hook}[$htype]{$id};
		947	$term->set_should_invoke ($htype, -1);
		948	}
		949	}
		950
		951	sub on {
		952	my ($self, %hook) = @_;
		953
		954	my $term = $self->{term};
		955
		956	my %disable = ( "" => $term );
		957
		958	while (my ($name, $cb) = each %hook) {
		959	my $htype = $HOOKTYPE{uc $name};
		960	defined $htype
		961	or Carp::croak "unsupported hook type '$name'";
		962
		963	$term->set_should_invoke ($htype, +1);
		964	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		965	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		966	}
		967
		968	bless \%disable, "urxvt::extension::on_disable"
		969	}
		970
		971	=item $self->bind_action ($hotkey, $action)
		972
		973	=item $self->x_resource ($pattern)
		974
		975	=item $self->x_resource_boolean ($pattern)
		976
		977	These methods support an additional C<%> prefix for C<$action> or
		978	C<$pattern> when called on an extension object, compared to the
		979	C<urxvt::term> methods of the same name - see the description of these
		980	methods in the C<urxvt::term> class for details.
		981
		982	=cut
		983
		984	sub bind_action {
		985	my ($self, $hotkey, $action) = @_;
		986	$action =~ s/^%:/$_[0]{_name}:/;
		987	$self->{term}->bind_action ($hotkey, $action)
		988	}
		989
		990	sub x_resource {
		991	my ($self, $name) = @_;
		992	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		993	$self->{term}->x_resource ($name)
		994	}
		995
		996	sub x_resource_boolean {
		997	my ($self, $name) = @_;
		998	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		999	$self->{term}->x_resource_boolean ($name)
		1000	}
		1001
		1002	=back
		1003
		1004	=cut
1133		1005
1134	package urxvt::anyevent;	1006	package urxvt::anyevent;
1135		1007
1136	=head2 The C<urxvt::anyevent> Class	1008	=head2 The C<urxvt::anyevent> Class
1137		1009
1138	The sole purpose of this class is to deliver an interface to the	1010	The sole purpose of this class is to deliver an interface to the
1139	C<AnyEvent> module - any module using it will work inside urxvt without	1011	C<AnyEvent> module - any module using it will work inside urxvt without
1140	further programming. The only exception is that you cannot wait on	1012	further programming. The only exception is that you cannot wait on
1141	condition variables, but non-blocking condvar use is ok. What this means	1013	condition variables, but non-blocking condvar use is ok.
1142	is that you cannot use blocking APIs, but the non-blocking variant should	1014
1143	work.	1015	In practical terms this means is that you cannot use blocking APIs, but
		1016	the non-blocking variant should work.
1144		1017
1145	=cut	1018	=cut
1146		1019
1147	our $VERSION = '5.23';	1020	our $VERSION = '5.23';
1148		1021
…		…
1207		1080
1208	sub DESTROY {	1081	sub DESTROY {
1209	$_[0][1]->stop;	1082	$_[0][1]->stop;
1210	}	1083	}
1211		1084
		1085	# only needed for AnyEvent < 6 compatibility
1212	sub one_event {	1086	sub one_event {
1213	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1087	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1214	}	1088	}
1215		1089
1216	package urxvt::term;	1090	package urxvt::term;
…		…
1231	urxvt::verbose 6, "register package $pkg to $self";	1105	urxvt::verbose 6, "register package $pkg to $self";
1232		1106
1233	@{"$pkg\::ISA"} = urxvt::term::extension::;	1107	@{"$pkg\::ISA"} = urxvt::term::extension::;
1234		1108
1235	my $proxy = bless {	1109	my $proxy = bless {
1236	_pkg => $pkg,	1110	_pkg => $pkg,
		1111	_name => ${"$pkg\::_NAME"}, # hackish
1237	argv => $argv,	1112	argv => $argv,
1238	}, $pkg;	1113	}, $pkg;
1239	Scalar::Util::weaken ($proxy->{term} = $self);	1114	Scalar::Util::weaken ($proxy->{term} = $self);
1240		1115
1241	$self->{_pkg}{$pkg} = $proxy;	1116	$self->{_pkg}{$pkg} = $proxy;
1242		1117
…		…
1245	$proxy->enable ($name => $ref);	1120	$proxy->enable ($name => $ref);
1246	}	1121	}
1247	}	1122	}
1248	}	1123	}
1249		1124
		1125	sub perl_libdirs {
		1126	map { split /:/ }
		1127	$_[0]->resource ("perl_lib"),
		1128	$ENV{URXVT_PERL_LIB},
		1129	"$ENV{HOME}/.urxvt/ext",
		1130	"$LIBDIR/perl"
		1131	}
		1132
		1133	# scan for available extensions and collect their metadata
		1134	sub scan_extensions {
		1135	my ($self) = @_;
		1136
		1137	return if exists $self->{meta};
		1138
		1139	my @urxvtdirs = perl_libdirs $self;
		1140	my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1141
		1142	$self->{meta} = \my %meta;
		1143
		1144	# first gather extensions
		1145
		1146	my $gather = sub {
		1147	my ($dir, $core) = @_;
		1148
		1149	opendir my $fh, $dir
		1150	or return;
		1151
		1152	for my $ext (readdir $fh) {
		1153	$ext !~ /^\./
		1154	or next;
		1155
		1156	open my $fh, "<", "$dir/$ext"
		1157	or next;
		1158
		1159	-f $fh
		1160	or next;
		1161
		1162	$ext =~ s/\.uext$// or $core
		1163	or next;
		1164
		1165	my %ext = (dir => $dir);
		1166
		1167	while (<$fh>) {
		1168	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1169	my ($pattern, $type, $desc) = split /:/, $1;
		1170	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1171	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1172	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1173	} else {
		1174	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1175	}
		1176	} elsif (/^\s*(?:#\|$)/) {
		1177	# skip other comments and empty lines
		1178	} else {
		1179	last; # stop parsing on first non-empty non-comment line
		1180	}
		1181	}
		1182
		1183	$meta{ext}{$ext} = \%ext;
		1184	}
		1185	};
		1186
		1187	$gather->($_, 0) for @cpandirs;
		1188	$gather->($_, 1) for @urxvtdirs;
		1189
		1190	# and now merge resources
		1191	while (my ($k, $v) = each %{ $meta{ext} }) {
		1192	#TODO: should check for extensions overriding each other
		1193	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1194	}
		1195	}
		1196
1250	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1197	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1251		1198
1252	Creates a new terminal, very similar as if you had started it with system	1199	Creates a new terminal, very similar as if you had started it with system
1253	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1200	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1254	hash which defines the environment of the new terminal.	1201	hash which defines the environment of the new terminal.
…		…
1271	}	1218	}
1272		1219
1273	=item $term->destroy	1220	=item $term->destroy
1274		1221
1275	Destroy the terminal object (close the window, free resources	1222	Destroy the terminal object (close the window, free resources
1276	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1223	etc.). Please note that urxvt will not exit as long as any event
1277	watchers (timers, io watchers) are still active.	1224	watchers (timers, io watchers) are still active.
1278		1225
1279	=item $term->exec_async ($cmd[, @args])	1226	=item $term->exec_async ($cmd[, @args])
1280		1227
1281	Works like the combination of the C<fork>/C<exec> builtins, which executes	1228	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1308	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1255	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1309		1256
1310	Here is a likely non-exhaustive list of option names, please see the	1257	Here is a likely non-exhaustive list of option names, please see the
1311	source file F</src/optinc.h> to see the actual list:	1258	source file F</src/optinc.h> to see the actual list:
1312		1259
1313	borderLess console cursorBlink cursorUnderline hold iconic insecure	1260	borderLess buffered console cursorBlink cursorUnderline hold iconic
1314	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1261	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1315	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1262	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1316	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1263	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1317	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1264	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1318	transparent tripleclickwords utmpInhibit visualBell	1265	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1266	urgentOnBell utmpInhibit visualBell
1319		1267
1320	=item $value = $term->resource ($name[, $newval])	1268	=item $value = $term->resource ($name[, $newval])
1321		1269
1322	Returns the current resource value associated with a given name and	1270	Returns the current resource value associated with a given name and
1323	optionally sets a new value. Setting values is most useful in the C<init>	1271	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1336		1284
1337	Here is a likely non-exhaustive list of resource names, not all of which	1285	Here is a likely non-exhaustive list of resource names, not all of which
1338	are supported in every build, please see the source file F</src/rsinc.h>	1286	are supported in every build, please see the source file F</src/rsinc.h>
1339	to see the actual list:	1287	to see the actual list:
1340		1288
1341	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1289	answerbackstring backgroundPixmap backspace_key blurradius
1342	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1290	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1343	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1291	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1344	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1292	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1345	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1293	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1346	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1294	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1366	Returns the X-Resource for the given pattern, excluding the program or	1314	Returns the X-Resource for the given pattern, excluding the program or
1367	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1315	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1368	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1316	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1369	resource with that pattern exists.	1317	resource with that pattern exists.
1370		1318
		1319	Extensions that define extra resources also need to call this method
		1320	to access their values.
		1321
		1322	If the method is called on an extension object (basically, from an
		1323	extension), then the special prefix C<%.> will be replaced by the name of
		1324	the extension and a dot, and the lone string C<%> will be replaced by the
		1325	extension name itself. This makes it possible to code extensions so you
		1326	can rename them and get a new set of resources without having to change
		1327	the actual code.
		1328
1371	This method should only be called during the C<on_start> hook, as there is	1329	This method should only be called during the C<on_start> hook, as there is
1372	only one resource database per display, and later invocations might return	1330	only one resource database per display, and later invocations might return
1373	the wrong resources.	1331	the wrong resources.
1374		1332
1375	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1333	=item $value = $term->x_resource_boolean ($pattern)
1376		1334
		1335	Like C<x_resource>, above, but interprets the string value as a boolean
		1336	and returns C<1> for true values, C<0> for false values and C<undef> if
		1337	the resource or option isn't specified.
		1338
		1339	You should always use this method to parse boolean resources.
		1340
		1341	=cut
		1342
		1343	sub x_resource_boolean {
		1344	my $res = &x_resource;
		1345
		1346	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1347	}
		1348
		1349	=item $success = $term->bind_action ($key, $action)
		1350
1377	Adds a keymap translation exactly as specified via a resource. See the	1351	Adds a key binding exactly as specified via a C<keysym> resource. See the
1378	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1352	C<keysym> resource in the urxvt(1) manpage.
		1353
		1354	To add default bindings for an extension, the extension should call C<<
		1355	->bind_action >> on it's C<init> hook for every such binding. Doing it
		1356	in the C<init> hook allows users the override or remove the the binding
		1357	again.
		1358
		1359	Example: the C<searchable-scrollback> by default binds itself
		1360	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1361	$term->bind_action >>.
		1362
		1363	sub init {
		1364	my ($self) = @_;
		1365
		1366	$self->bind_action ("M-s" => "%:start");
		1367	}
1379		1368
1380	=item $rend = $term->rstyle ([$new_rstyle])	1369	=item $rend = $term->rstyle ([$new_rstyle])
1381		1370
1382	Return and optionally change the current rendition. Text that is output by	1371	Return and optionally change the current rendition. Text that is output by
1383	the terminal application will use this style.	1372	the terminal application will use this style.
…		…
1541		1530
1542	=item $term->scr_add_lines ($string)	1531	=item $term->scr_add_lines ($string)
1543		1532
1544	Write the given text string to the screen, as if output by the application	1533	Write the given text string to the screen, as if output by the application
1545	running inside the terminal. It may not contain command sequences (escape	1534	running inside the terminal. It may not contain command sequences (escape
1546	codes), but is free to use line feeds, carriage returns and tabs. The	1535	codes - see C<cmd_parse> for that), but is free to use line feeds,
1547	string is a normal text string, not in locale-dependent encoding.	1536	carriage returns and tabs. The string is a normal text string, not in
		1537	locale-dependent encoding.
1548		1538
1549	Normally its not a good idea to use this function, as programs might be	1539	Normally its not a good idea to use this function, as programs might be
1550	confused by changes in cursor position or scrolling. Its useful inside a	1540	confused by changes in cursor position or scrolling. Its useful inside a
1551	C<on_add_lines> hook, though.	1541	C<on_add_lines> hook, though.
1552		1542
…		…
1560	locale-specific encoding of the terminal and can contain command sequences	1550	locale-specific encoding of the terminal and can contain command sequences
1561	(escape codes) that will be interpreted.	1551	(escape codes) that will be interpreted.
1562		1552
1563	=item $term->tt_write ($octets)	1553	=item $term->tt_write ($octets)
1564		1554
1565	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1555	Write the octets given in C<$octets> to the tty (i.e. as user input
		1556	to the program, see C<cmd_parse> for the opposite direction). To pass
1566	pass characters instead of octets, you should convert your strings first	1557	characters instead of octets, you should convert your strings first to the
1567	to the locale-specific encoding using C<< $term->locale_encode >>.	1558	locale-specific encoding using C<< $term->locale_encode >>.
		1559
		1560	=item $term->tt_write_user_input ($octets)
		1561
		1562	Like C<tt_write>, but should be used when writing strings in response to
		1563	the user pressing a key, to invoke the additional actions requested by
		1564	the user for that case (C<tt_write> doesn't do that).
		1565
		1566	The typical use case would be inside C<on_action> hooks.
1568		1567
1569	=item $term->tt_paste ($octets)	1568	=item $term->tt_paste ($octets)
1570		1569
1571	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1570	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1572	CR and bracketing the data with control sequences if bracketed paste mode	1571	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1596		1595
1597	Adds the specified events to the vt event mask. Useful e.g. when you want	1596	Adds the specified events to the vt event mask. Useful e.g. when you want
1598	to receive pointer events all the times:	1597	to receive pointer events all the times:
1599		1598
1600	$term->vt_emask_add (urxvt::PointerMotionMask);	1599	$term->vt_emask_add (urxvt::PointerMotionMask);
		1600
		1601	=item $term->set_urgency ($set)
		1602
		1603	Enable/disable the urgency hint on the toplevel window.
1601		1604
1602	=item $term->focus_in	1605	=item $term->focus_in
1603		1606
1604	=item $term->focus_out	1607	=item $term->focus_out
1605		1608
…		…
1802	}	1805	}
1803		1806
1804	sub urxvt::line::t {	1807	sub urxvt::line::t {
1805	my ($self) = @_;	1808	my ($self) = @_;
1806		1809
1807	if (@_ > 1)	1810	if (@_ > 1) {
1808	{
1809	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1811	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1810	for $self->{beg} .. $self->{end};	1812	for $self->{beg} .. $self->{end};
1811	}	1813	}
1812		1814
1813	defined wantarray &&	1815	defined wantarray &&
1814	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1816	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1815	0, $self->{len}	1817	0, $self->{len}
1816	}	1818	}
1817		1819
1818	sub urxvt::line::r {	1820	sub urxvt::line::r {
1819	my ($self) = @_;	1821	my ($self) = @_;
1820		1822
1821	if (@_ > 1)	1823	if (@_ > 1) {
1822	{
1823	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1824	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1824	for $self->{beg} .. $self->{end};	1825	for $self->{beg} .. $self->{end};
1825	}	1826	}
1826		1827
1827	if (defined wantarray) {	1828	if (defined wantarray) {
1828	my $rend = [	1829	my $rend = [
1829	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1830	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1830	];	1831	];
…		…
1921	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1922	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1922		1923
1923	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1924	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1924		1925
1925	=item $term->XChangeInput ($window, $add_events[, $del_events])	1926	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1927
		1928	=item $keysym = $term->XStringToKeysym ($string)
		1929
		1930	=item $string = $term->XKeysymToString ($keysym)
1926		1931
1927	Various X or X-related functions. The C<$term> object only serves as	1932	Various X or X-related functions. The C<$term> object only serves as
1928	the source of the display, otherwise those functions map more-or-less	1933	the source of the display, otherwise those functions map more-or-less
1929	directly onto the X functions of the same name.	1934	directly onto the X functions of the same name.
1930		1935

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC vs. Revision 1.249 by root, Fri Dec 26 21:26:37 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC vs.
Revision 1.249 by root, Fri Dec 26 21:26:37 2014 UTC