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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.172 by root, Fri Oct 10 00:21:15 2008 UTC vs.
Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 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 that add command line parameters or resources on their own are
48		49	loaded automatically when used.
49	=item selection (enabled by default)
50
51	(More) intelligent selection. This extension tries to be more intelligent
52	when the user extends selections (double-click and further clicks). Right
53	now, it tries to select words, urls and complete shell-quoted
54	arguments, which is very convenient, too, if your F<ls> supports
55	C<--quoting-style=shell>.
56
57	A double-click usually selects the word under the cursor, further clicks
58	will enlarge the selection.
59
60	The selection works by trying to match a number of regexes and displaying
61	them in increasing order of length. You can add your own regexes by
62	specifying resources of the form:
63
64	URxvt.selection.pattern-0: perl-regex
65	URxvt.selection.pattern-1: perl-regex
66	...
67
68	The index number (0, 1...) must not have any holes, and each regex must
69	contain at least one pair of capturing parentheses, which will be used for
70	the match. For example, the following adds a regex that matches everything
71	between two vertical bars:
72
73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
74
75	Another example: Programs I use often output "absolute path: " at the
76	beginning of a line when they process multiple files. The following
77	pattern matches the filename (note, there is a single space at the very
78	end):
79
80	URxvt.selection.pattern-0: ^(/[^:]+):\
81
82	You can look at the source of the selection extension to see more
83	interesting uses, such as parsing a line from beginning to end.
84
85	This extension also offers following bindable keyboard commands:
86
87	=over 4
88
89	=item rot13
90
91	Rot-13 the selection when activated. Used via keyboard trigger:
92
93	URxvt.keysym.C-M-r: perl:selection:rot13
94
95	=back
96
97	=item option-popup (enabled by default)
98
99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
100	runtime.
101
102	Other extensions can extend this popup menu by pushing a code reference
103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104	popup is being displayed.
105
106	Its sole argument is the popup menu, which can be modified. It should
107	either return nothing or a string, the initial boolean value and a code
108	reference. The string will be used as button text and the code reference
109	will be called when the toggle changes, with the new boolean value as
110	first argument.
111
112	The following will add an entry C<myoption> that changes
113	C<< $self->{myoption} >>:
114
115	push @{ $self->{term}{option_popup_hook} }, sub {
116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117	};
118
119	=item selection-popup (enabled by default)
120
121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122	text into various other formats/action (such as uri unescaping, perl
123	evaluation, web-browser starting etc.), depending on content.
124
125	Other extensions can extend this popup menu by pushing a code reference
126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127	popup is being displayed.
128
129	Its sole argument is the popup menu, which can be modified. The selection
130	is in C<$_>, which can be used to decide whether to add something or not.
131	It should either return nothing or a string and a code reference. The
132	string will be used as button text and the code reference will be called
133	when the button gets activated and should transform C<$_>.
134
135	The following will add an entry C<a to b> that transforms all C<a>s in
136	the selection to C<b>s, but only if the selection currently contains any
137	C<a>s:
138
139	push @{ $self->{term}{selection_popup_hook} }, sub {
140	/a/ ? ("a to b" => sub { s/a/b/g }
141	: ()
142	};
143
144	=item searchable-scrollback<hotkey> (enabled by default)
145
146	Adds regex search functionality to the scrollback buffer, triggered
147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
148	input/output is suspended and a regex is displayed at the bottom of the
149	screen.
150
151	Inputting characters appends them to the regex and continues incremental
152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
154	bottom. C<Escape> leaves search mode and returns to the point where search
155	was started, while C<Enter> or C<Return> stay at the current position and
156	additionally stores the first match in the current line into the primary
157	selection if the C<Shift> modifier is active.
158
159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
160	get a case-sensitive search you can delete this prefix using C<BackSpace>
161	or simply use an uppercase character which removes the "(?i)" prefix.
162
163	See L<perlre> for more info about perl regular expression syntax.
164
165	=item readline (enabled by default)
166
167	A support package that tries to make editing with readline easier. At
168	the moment, it reacts to clicking shift-left mouse button by trying to
169	move the text cursor to this position. It does so by generating as many
170	cursor-left or cursor-right keypresses as required (this only works
171	for programs that correctly support wide characters).
172
173	To avoid too many false positives, this is only done when:
174
175	=over 4
176
177	=item - the tty is in ICANON state.
178
179	=item - the text cursor is visible.
180
181	=item - the primary screen is currently being displayed.
182
183	=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185	=back
186
187	The normal selection mechanism isn't disabled, so quick successive clicks
188	might interfere with selection creation in harmless ways.
189
190	=item selection-autotransform
191
192	This selection allows you to do automatic transforms on a selection
193	whenever a selection is made.
194
195	It works by specifying perl snippets (most useful is a single C<s///>
196	operator) that modify C<$_> as resources:
197
198	URxvt.selection-autotransform.0: transform
199	URxvt.selection-autotransform.1: transform
200	...
201
202	For example, the following will transform selections of the form
203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
204	$word>:
205
206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208	And this example matches the same,but replaces it with vi-commands you can
209	paste directly into your (vi :) editor:
210
211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213	Of course, this can be modified to suit your needs and your editor :)
214
215	To expand the example above to typical perl error messages ("XXX at
216	FILENAME line YYY."), you need a slightly more elaborate solution:
217
218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221	The first line tells the selection code to treat the unchanging part of
222	every error message as a selection pattern, and the second line transforms
223	the message into vi commands to load the file.
224
225	=item tabbed
226
227	This transforms the terminal into a tabbar with additional terminals, that
228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230	button per tab.
231
232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
233	B<Shift-Right> will switch to the tab left or right of the current one,
234	while B<Shift-Down> creates a new tab.
235
236	The tabbar itself can be configured similarly to a normal terminal, but
237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
238	following four resources (shown with defaults):
239
240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242	URxvt.tabbed.tab-fg: <colour-index, default 0>
243	URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246	indices.
247
248	=item matcher
249
250	Uses per-line display filtering (C<on_line_update>) to underline text
251	matching a certain pattern and make it clickable. When clicked with the
252	mouse button specified in the C<matcher.button> resource (default 2, or
253	middle), the program specified in the C<matcher.launcher> resource
254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255	with the matched text as first argument. The default configuration is
256	suitable for matching URLs and launching a web browser, like the
257	former "mark-urls" extension.
258
259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.
263
264	It is possible to activate the most recently seen match 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 block-graphics-to-ascii
309
310	A not very useful example of filtering all text output to the terminal
311	by replacing all line-drawing characters (U+2500 .. U+259F) by a
312	similar-looking ascii character.
313
314	=item digital-clock
315
316	Displays a digital clock using the built-in overlay.
317
318	=item remote-clipboard
319
320	Somewhat of a misnomer, this extension adds two menu entries to the
321	selection popup that allows one to run external commands to store the
322	selection somewhere and fetch it again.
323
324	We use it to implement a "distributed selection mechanism", which just
325	means that one command uploads the file to a remote server, and another
326	reads it.
327
328	The commands can be set using the C<URxvt.remote-selection.store> and
329	C<URxvt.remote-selection.fetch> resources. The first should read the
330	selection to store from STDIN (always in UTF-8), the second should provide
331	the selection data on STDOUT (also in UTF-8).
332
333	The defaults (which are likely useless to you) use rsh and cat:
334
335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337
338	=item selection-pastebin
339
340	This is a little rarely useful extension that Uploads the selection as
341	textfile to a remote site (or does other things). (The implementation is
342	not currently secure for use in a multiuser environment as it writes to
343	F</tmp> directly.).
344
345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
346	i.e.
347
348	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
349
350	Pressing this combination runs a command with C<%> replaced by the name of
351	the textfile. This command can be set via a resource:
352
353	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
354
355	And the default is likely not useful to anybody but the few people around
356	here :)
357
358	The name of the textfile is the hex encoded md5 sum of the selection, so
359	the same content should lead to the same filename.
360
361	After a successful upload the selection will be replaced by the text given
362	in the C<selection-pastebin-url> resource (again, the % is the placeholder
363	for the filename):
364
365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366
367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
368	the double C</> characters as comment start. Use C<\057\057> instead,
369	which works regardless of wether xrdb is used to parse the resource file
370	or not.
371
372	=item example-refresh-hooks
373
374	Displays a very simple digital clock in the upper right corner of the
375	window. Illustrates overwriting the refresh callbacks to create your own
376	overlays or changes.
377
378	=back
379		50
380	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
381		52
382	=head2 General API Considerations	53	=head2 General API Considerations
383		54
397		68
398	=over 4	69	=over 4
399		70
400	=item $text	71	=item $text
401		72
402	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
403	always represents one screen cell. See L<ROW_t> for a discussion of this format.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
404		75
405	=item $string	76	=item $string
406		77
407	A perl text string, with an emphasis on I<text>. It can store all unicode	78	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
411	=item $octets	82	=item $octets
412		83
413	Either binary data or - more common - a text string encoded in a	84	Either binary data or - more common - a text string encoded in a
414	locale-specific way.	85	locale-specific way.
415		86
		87	=item $keysym
		88
		89	an integer that is a valid X11 keysym code. You can convert a string
		90	into a keysym and viceversa by using C<XStringToKeysym> and
		91	C<XKeysymToString>.
		92
416	=back	93	=back
417		94
418	=head2 Extension Objects	95	=head2 Extension Objects
419		96
420	Every perl extension is a perl class. A separate perl object is created	97	Every perl extension is a perl class. A separate perl object is created
421	for each terminal, and each terminal has its own set of extenion objects,	98	for each terminal, and each terminal has its own set of extension objects,
422	which are passed as the first parameter to hooks. So extensions can use	99	which are passed as the first parameter to hooks. So extensions can use
423	their C<$self> object without having to think about clashes with other	100	their C<$self> object without having to think about clashes with other
424	extensions or other terminals, with the exception of methods and members	101	extensions or other terminals, with the exception of methods and members
425	that begin with an underscore character C<_>: these are reserved for	102	that begin with an underscore character C<_>: these are reserved for
426	internal use.	103	internal use.
427		104
428	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
429	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
430		107
431	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
432		109	the C<urxvt::extension> section below.
433	=over 4
434
435	=item $urxvt_term = $self->{term}
436
437	Returns the C<urxvt::term> object associated with this instance of the
438	extension. This member I<must not> be changed in any way.
439
440	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
441
442	Dynamically enable the given hooks (named without the C<on_> prefix) for
443	this extension, replacing any previous hook. This is useful when you want
444	to overwrite time-critical hooks only temporarily.
445
446	=item $self->disable ($hook_name[, $hook_name..])
447
448	Dynamically disable the given hooks.
449
450	=back
451		110
452	=head2 Hooks	111	=head2 Hooks
453		112
454	The following subroutines can be declared in extension files, and will be	113	The following subroutines can be declared in extension files, and will be
455	called whenever the relevant event happens.	114	called whenever the relevant event happens.
…		…
590	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
591		250
592	Called whenever some data is written to the tty/pty and can be used to	251	Called whenever some data is written to the tty/pty and can be used to
593	suppress or filter tty input.	252	suppress or filter tty input.
594		253
		254	=item on_tt_paste $term, $octets
		255
		256	Called whenever text is about to be pasted, with the text as argument. You
		257	can filter/change and paste the text yourself by returning a true value
		258	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		259	locale-encoded.
		260
595	=item on_line_update $term, $row	261	=item on_line_update $term, $row
596		262
597	Called whenever a line was updated or changed. Can be used to filter	263	Called whenever a line was updated or changed. Can be used to filter
598	screen output (e.g. underline urls or other useless stuff). Only lines	264	screen output (e.g. underline urls or other useless stuff). Only lines
599	that are being shown will be filtered, and, due to performance reasons,	265	that are being shown will be filtered, and, due to performance reasons,
…		…
615		281
616	=item on_refresh_end $term	282	=item on_refresh_end $term
617		283
618	Called just after the screen gets redrawn. See C<on_refresh_begin>.	284	Called just after the screen gets redrawn. See C<on_refresh_begin>.
619		285
620	=item on_user_command $term, $string	286	=item on_user_command $term, $string DEPRECATED
621		287
622	Called whenever a user-configured event is being activated (e.g. via	288	Called whenever a user-configured event is being activated (e.g. via
623	a C<perl:string> action bound to a key, see description of the B<keysym>	289	a C<perl:string> action bound to a key, see description of the B<keysym>
624	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
625		291
626	The event is simply the action string. This interface is assumed to change	292	The event is simply the action string. This interface is going away in
627	slightly in the future.	293	preference to the C<on_action> hook.
628		294
629	=item on_resize_all_windows $tern, $new_width, $new_height	295	=item on_resize_all_windows $term, $new_width, $new_height
630		296
631	Called just after the new window size has been calculated, but before	297	Called just after the new window size has been calculated, but before
632	windows are actually being resized or hints are being set. If this hook	298	windows are actually being resized or hints are being set. If this hook
633	returns TRUE, setting of the window hints is being skipped.	299	returns a true value, setting of the window hints is being skipped.
634		300
635	=item on_x_event $term, $event	301	=item on_x_event $term, $event
636		302
637	Called on every X event received on the vt window (and possibly other	303	Called on every X event received on the vt window (and possibly other
638	windows). Should only be used as a last resort. Most event structure	304	windows). Should only be used as a last resort. Most event structure
…		…
668		334
669	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
670		336
671	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
672		338
673	Called whenever the corresponding X event is received for the terminal If	339	Called whenever the corresponding X event is received for the terminal. If
674	the hook returns true, then the even will be ignored by rxvt-unicode.	340	the hook returns true, then the event will be ignored by rxvt-unicode.
675		341
676	The event is a hash with most values as named by Xlib (see the XEvent	342	The event is a hash with most values as named by Xlib (see the XEvent
677	manpage), with the additional members C<row> and C<col>, which are the	343	manpage), with the additional members C<row> and C<col>, which are the
678	(real, not screen-based) row and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
679		345
680	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
681	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
682		348
683	subwindow.
684
685	=item on_client_message $term, $event	349	=item on_client_message $term, $event
686		350
687	=item on_wm_protocols $term, $event	351	=item on_wm_protocols $term, $event
688		352
689	=item on_wm_delete_window $term, $event	353	=item on_wm_delete_window $term, $event
690		354
691	Called when various types of ClientMessage events are received (all with	355	Called when various types of ClientMessage events are received (all with
692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	356	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
693		357
		358	=item on_bell $term
		359
		360	Called on receipt of a bell character.
		361
694	=back	362	=back
695		363
696	=cut	364	=cut
697		365
698	package urxvt;	366	package urxvt;
699		367
700	use utf8;	368	use utf8;
701	use strict;	369	use strict 'vars';
702	use Carp ();	370	use Carp ();
703	use Scalar::Util ();	371	use Scalar::Util ();
704	use List::Util ();	372	use List::Util ();
705		373
706	our $VERSION = 1;	374	our $VERSION = 1;
707	our $TERM;	375	our $TERM;
708	our @TERM_INIT;	376	our @TERM_INIT; # should go, prevents async I/O etc.
709	our @TERM_EXT;	377	our @TERM_EXT; # should go, prevents async I/O etc.
710	our @HOOKNAME;	378	our @HOOKNAME;
711	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
712	our %OPTION;	380	our %OPTION;
713		381
714	our $LIBDIR;	382	our $LIBDIR;
…		…
762		430
763	=over 4	431	=over 4
764		432
765	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
766		434
767	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
768	costs! The only time this is acceptable is when the terminal process	436	include a trailing newline). Avoid at all costs! The only time this
769	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
770		439
771	=item urxvt::warn $string	440	=item urxvt::warn $string
772		441
773	Calls C<rxvt_warn> with the given string which should not include a	442	Calls C<rxvt_warn> with the given string which should include a trailing
774	newline. The module also overwrites the C<warn> builtin with a function	443	newline. The module also overwrites the C<warn> builtin with a function
775	that calls this function.	444	that calls this function.
776		445
777	Using this function has the advantage that its output ends up in the	446	Using this function has the advantage that its output ends up in the
778	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
782	=item @terms = urxvt::termlist	451	=item @terms = urxvt::termlist
783		452
784	Returns all urxvt::term objects that exist in this process, regardless of	453	Returns all urxvt::term objects that exist in this process, regardless of
785	whether they are started, being destroyed etc., so be careful. Only term	454	whether they are started, being destroyed etc., so be careful. Only term
786	objects that have perl extensions attached will be returned (because there	455	objects that have perl extensions attached will be returned (because there
787	is no urxvt::term objet associated with others).	456	is no urxvt::term object associated with others).
788		457
789	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
790		459
791	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
792		461
…		…
835		504
836	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
837		506
838	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
839		508
840	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	509	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		510	urxvt::RS_RVid, urxvt::RS_Uline
841		511
842	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
843	underline, respectively. To enable such a style, just logically OR it into	513	underline, respectively. To enable such a style, just logically OR it into
844	the bitset.	514	the bitset.
845		515
…		…
882	};	552	};
883	}	553	}
884		554
885	no warnings 'utf8';	555	no warnings 'utf8';
886		556
		557	sub parse_resource {
		558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		559
		560	$term->scan_extensions;
		561
		562	my $r = $term->{meta}{resource};
		563	keys %$r; # reset iterator
		564	while (my ($k, $v) = each %$r) {
		565	my $pattern = $k;
		566	$pattern =~ y/./-/ if $isarg;
		567	my $prefix = $name;
		568	my $suffix;
		569	if ($pattern =~ /\-$/) {
		570	$prefix = substr $name, 0, length $pattern;
		571	$suffix = substr $name, length $pattern;
		572	}
		573	if ($pattern eq $prefix) {
		574	$name = "$urxvt::RESCLASS.$k$suffix";
		575
		576	push @{ $term->{perl_ext_3} }, $v->[0];
		577
		578	if ($v->[1] eq "boolean") {
		579	$term->put_option_db ($name, $flag ? "true" : "false");
		580	return 1;
		581	} else {
		582	$term->put_option_db ($name, $value);
		583	return 1 + 2;
		584	}
		585	}
		586	}
		587
		588	0
		589	}
		590
		591	sub usage {
		592	my ($term, $usage_type) = @_;
		593
		594	$term->scan_extensions;
		595
		596	my $r = $term->{meta}{resource};
		597
		598	for my $pattern (sort keys %$r) {
		599	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		600
		601	$desc .= " (-pe $ext)";
		602
		603	if ($usage_type == 1) {
		604	$pattern =~ y/./-/;
		605	$pattern =~ s/-$/-.../g;
		606
		607	if ($type eq "boolean") {
		608	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		609	} else {
		610	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		611	}
		612	} else {
		613	$pattern =~ s/\.$/.*/g;
		614	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		615	}
		616	}
		617	}
		618
887	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	619	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
888		620
889	sub verbose {	621	sub verbose {
890	my ($level, $msg) = @_;	622	my ($level, $msg) = @_;
891	warn "$msg\n" if $level <= $verbosity;	623	warn "$msg\n" if $level <= $verbosity;
…		…
903	$pkg =~ s/[^[:word:]]/_/g;	635	$pkg =~ s/[^[:word:]]/_/g;
904	$pkg = "urxvt::ext::$pkg";	636	$pkg = "urxvt::ext::$pkg";
905		637
906	verbose 3, "loading extension '$path' into package '$pkg'";	638	verbose 3, "loading extension '$path' into package '$pkg'";
907		639
		640	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		641
908	open my $fh, "<:raw", $path	642	open my $fh, "<:raw", $path
909	or die "$path: $!";	643	or die "$path: $!";
910		644
911	my $source =	645	my $source =
912	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	646	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
913	. "#line 1 \"$path\"\n{\n"	647	. "#line 1 \"$path\"\n{\n"
914	. (do { local $/; <$fh> })	648	. (do { local $/; <$fh> })
915	. "\n};\n1";	649	. "\n};\n1";
916		650
917	eval $source	651	eval $source
…		…
926	# called by the rxvt core	660	# called by the rxvt core
927	sub invoke {	661	sub invoke {
928	local $TERM = shift;	662	local $TERM = shift;
929	my $htype = shift;	663	my $htype = shift;
930		664
931	if ($htype == 0) { # INIT	665	if ($htype == HOOK_INIT) {
932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	666	my @dirs = $TERM->perl_libdirs;
		667
		668	$TERM->scan_extensions;
933		669
934	my %ext_arg;	670	my %ext_arg;
935		671
936	{	672	{
937	my @init = @TERM_INIT;	673	my @init = @TERM_INIT;
…		…
940	my @pkg = @TERM_EXT;	676	my @pkg = @TERM_EXT;
941	@TERM_EXT = ();	677	@TERM_EXT = ();
942	$TERM->register_package ($_) for @pkg;	678	$TERM->register_package ($_) for @pkg;
943	}	679	}
944		680
		681	for (
945	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	682	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		683	) {
946	if ($_ eq "default") {	684	if ($_ eq "default") {
947	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	685
		686	$ext_arg{$_} = []
		687	for
		688	qw(selection option-popup selection-popup readline),
		689	@{ delete $TERM->{perl_ext_3} },
		690	map $_->[0], values %{ $TERM->{meta}{binding} };
		691
		692	for ($TERM->_keysym_resources) {
		693	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		694	next unless /^([A-Za-z0-9_\-]+):/;
		695
		696	my $ext = $1;
		697
		698	$ext_arg{$ext} = [];
		699	}
		700
948	} elsif (/^-(.*)$/) {	701	} elsif (/^-(.*)$/) {
949	delete $ext_arg{$1};	702	delete $ext_arg{$1};
		703
950	} elsif (/^([^<]+)<(.*)>$/) {	704	} elsif (/^([^<]+)<(.*)>$/) {
951	push @{ $ext_arg{$1} }, $2;	705	push @{ $ext_arg{$1} }, $2;
		706
952	} else {	707	} else {
953	$ext_arg{$_} \|\|= [];	708	$ext_arg{$_} \|\|= [];
		709	}
		710	}
		711
		712	# now register default key bindings
		713	for my $ext (sort keys %ext_arg) {
		714	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		715	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
954	}	716	}
955	}	717	}
956		718
957	for my $ext (sort keys %ext_arg) {	719	for my $ext (sort keys %ext_arg) {
958	my @files = grep -f $_, map "$_/$ext", @dirs;	720	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
972		734
973	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
974	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
975	if $verbosity >= 10;	737	if $verbosity >= 10;
976		738
		739	if ($htype == HOOK_ACTION) {
		740	# this hook is only sent to the extension with the name
		741	# matching the first arg
		742	my $pkg = shift;
		743	$pkg =~ y/-/_/;
		744	$pkg = "urxvt::ext::$pkg";
		745
		746	$cb = $cb->{$pkg}
		747	or return undef; #TODO: maybe warn user?
		748
		749	$cb = { $pkg => $cb };
		750	}
		751
977	for my $pkg (keys %$cb) {	752	for my $pkg (keys %$cb) {
978	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	753	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
979	$retval \|\|= $retval_;	754	$retval \|\|= $retval_;
980		755
981	if ($@) {	756	if ($@) {
982	$TERM->ungrab; # better to lose the grab than the session	757	$TERM->ungrab; # better to lose the grab than the session
983	warn $@;	758	warn $@;
…		…
986		761
987	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	762	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
988	if $verbosity >= 11;	763	if $verbosity >= 11;
989	}	764	}
990		765
991	if ($htype == 1) { # DESTROY	766	if ($htype == HOOK_DESTROY) {
992	# clear package objects	767	# clear package objects
993	%$_ = () for values %{ $TERM->{_pkg} };	768	%$_ = () for values %{ $TERM->{_pkg} };
994		769
995	# clear package	770	# clear package
996	%$TERM = ();	771	%$TERM = ();
…		…
1026	}	801	}
1027	}	802	}
1028	($mask, @color{qw(fg bg)}, \@failed)	803	($mask, @color{qw(fg bg)}, \@failed)
1029	}	804	}
1030		805
1031	# urxvt::term::extension
1032
1033	package urxvt::term::extension;	806	package urxvt::term::extension;
1034		807
1035	sub enable {	808	=head2 The C<urxvt::term::extension> class
1036	my ($self, %hook) = @_;
1037	my $pkg = $self->{_pkg};
1038		809
1039	while (my ($name, $cb) = each %hook) {	810	Each extension attached to a terminal object is represented by
1040	my $htype = $HOOKTYPE{uc $name};	811	a C<urxvt::term::extension> object.
1041	defined $htype
1042	or Carp::croak "unsupported hook type '$name'";
1043		812
1044	$self->set_should_invoke ($htype, +1)	813	You can use these objects, which are passed to all callbacks to store any
1045	unless exists $self->{term}{_hook}[$htype]{$pkg};	814	state related to the terminal and extension instance.
1046		815
1047	$self->{term}{_hook}[$htype]{$pkg} = $cb;	816	The methods (And data members) documented below can be called on extension
1048	}	817	objects, in addition to call methods documented for the <urxvt::term>
1049	}	818	class.
1050		819
1051	sub disable {	820	=over 4
1052	my ($self, @hook) = @_;
1053	my $pkg = $self->{_pkg};
1054		821
1055	for my $name (@hook) {	822	=item $urxvt_term = $self->{term}
1056	my $htype = $HOOKTYPE{uc $name};
1057	defined $htype
1058	or Carp::croak "unsupported hook type '$name'";
1059		823
1060	$self->set_should_invoke ($htype, -1)	824	Returns the C<urxvt::term> object associated with this instance of the
1061	if delete $self->{term}{_hook}[$htype]{$pkg};	825	extension. This member I<must not> be changed in any way.
1062	}	826
1063	}	827	=cut
1064		828
1065	our $AUTOLOAD;	829	our $AUTOLOAD;
1066		830
1067	sub AUTOLOAD {	831	sub AUTOLOAD {
1068	$AUTOLOAD =~ /:([^:]+)$/	832	$AUTOLOAD =~ /:([^:]+)$/
…		…
1081		845
1082	sub DESTROY {	846	sub DESTROY {
1083	# nop	847	# nop
1084	}	848	}
1085		849
1086	# urxvt::destroy_hook	850	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1087		851
1088	sub urxvt::destroy_hook::DESTROY {	852	sub urxvt::destroy_hook::DESTROY {
1089	${$_[0]}->();	853	${$_[0]}->();
1090	}	854	}
1091		855
1092	sub urxvt::destroy_hook(&) {	856	sub urxvt::destroy_hook(&) {
1093	bless \shift, urxvt::destroy_hook::	857	bless \shift, urxvt::destroy_hook::
1094	}	858	}
		859
		860	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		861
		862	Dynamically enable the given hooks (named without the C<on_> prefix) for
		863	this extension, replacing any hook previously installed via C<enable> in
		864	this extension.
		865
		866	This is useful when you want to overwrite time-critical hooks only
		867	temporarily.
		868
		869	To install additional callbacks for the same hook, you can use the C<on>
		870	method of the C<urxvt::term> class.
		871
		872	=item $self->disable ($hook_name[, $hook_name..])
		873
		874	Dynamically disable the given hooks.
		875
		876	=cut
		877
		878	sub enable {
		879	my ($self, %hook) = @_;
		880	my $pkg = $self->{_pkg};
		881
		882	while (my ($name, $cb) = each %hook) {
		883	my $htype = $HOOKTYPE{uc $name};
		884	defined $htype
		885	or Carp::croak "unsupported hook type '$name'";
		886
		887	$self->set_should_invoke ($htype, +1)
		888	unless exists $self->{term}{_hook}[$htype]{$pkg};
		889
		890	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		891	}
		892	}
		893
		894	sub disable {
		895	my ($self, @hook) = @_;
		896	my $pkg = $self->{_pkg};
		897
		898	for my $name (@hook) {
		899	my $htype = $HOOKTYPE{uc $name};
		900	defined $htype
		901	or Carp::croak "unsupported hook type '$name'";
		902
		903	$self->set_should_invoke ($htype, -1)
		904	if delete $self->{term}{_hook}[$htype]{$pkg};
		905	}
		906	}
		907
		908	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		909
		910	Similar to the C<enable> enable, but installs additional callbacks for
		911	the given hook(s) (that is, it doesn't replace existing callbacks), and
		912	returns a guard object. When the guard object is destroyed the callbacks
		913	are disabled again.
		914
		915	=cut
		916
		917	sub urxvt::extension::on_disable::DESTROY {
		918	my $disable = shift;
		919
		920	my $term = delete $disable->{""};
		921
		922	while (my ($htype, $id) = each %$disable) {
		923	delete $term->{_hook}[$htype]{$id};
		924	$term->set_should_invoke ($htype, -1);
		925	}
		926	}
		927
		928	sub on {
		929	my ($self, %hook) = @_;
		930
		931	my $term = $self->{term};
		932
		933	my %disable = ( "" => $term );
		934
		935	while (my ($name, $cb) = each %hook) {
		936	my $htype = $HOOKTYPE{uc $name};
		937	defined $htype
		938	or Carp::croak "unsupported hook type '$name'";
		939
		940	$term->set_should_invoke ($htype, +1);
		941	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		942	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		943	}
		944
		945	bless \%disable, "urxvt::extension::on_disable"
		946	}
		947
		948	=item $self->x_resource ($pattern)
		949
		950	=item $self->x_resource_boolean ($pattern)
		951
		952	These methods support an additional C<%> prefix when called on an
		953	extension object - see the description of these methods in the
		954	C<urxvt::term> class for details.
		955
		956	=cut
		957
		958	sub x_resource {
		959	my ($self, $name) = @_;
		960	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		961	$self->{term}->x_resource ($name)
		962	}
		963
		964	sub x_resource_boolean {
		965	my ($self, $name) = @_;
		966	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		967	$self->{term}->x_resource_boolean ($name)
		968	}
		969
		970	=back
		971
		972	=cut
1095		973
1096	package urxvt::anyevent;	974	package urxvt::anyevent;
1097		975
1098	=head2 The C<urxvt::anyevent> Class	976	=head2 The C<urxvt::anyevent> Class
1099		977
1100	The sole purpose of this class is to deliver an interface to the	978	The sole purpose of this class is to deliver an interface to the
1101	C<AnyEvent> module - any module using it will work inside urxvt without	979	C<AnyEvent> module - any module using it will work inside urxvt without
1102	further programming. The only exception is that you cannot wait on	980	further programming. The only exception is that you cannot wait on
1103	condition variables, but non-blocking condvar use is ok. What this means	981	condition variables, but non-blocking condvar use is ok.
1104	is that you cannot use blocking APIs, but the non-blocking variant should
1105	work.
1106		982
1107	=cut	983	In practical terms this means is that you cannot use blocking APIs, but
		984	the non-blocking variant should work.
1108		985
		986	=cut
		987
1109	our $VERSION = '3.4';	988	our $VERSION = '5.23';
1110		989
1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	990	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	991	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113		992
1114	sub timer {	993	sub timer {
…		…
1116		995
1117	my $cb = $arg{cb};	996	my $cb = $arg{cb};
1118		997
1119	urxvt::timer	998	urxvt::timer
1120	->new	999	->new
1121	->start (urxvt::NOW + $arg{after})	1000	->after ($arg{after}, $arg{interval})
1122	->cb (sub {	1001	->cb ($arg{interval} ? $cb : sub {
1123	$_[0]->stop; # need to cancel manually	1002	$_[0]->stop; # need to cancel manually
1124	$cb->();	1003	$cb->();
1125	})	1004	})
1126	}	1005	}
1127		1006
1128	sub io {	1007	sub io {
1129	my ($class, %arg) = @_;	1008	my ($class, %arg) = @_;
1130		1009
1131	my $cb = $arg{cb};	1010	my $cb = $arg{cb};
		1011	my $fd = fileno $arg{fh};
		1012	defined $fd or $fd = $arg{fh};
1132		1013
1133	bless [$arg{fh}, urxvt::iow	1014	bless [$arg{fh}, urxvt::iow
1134	->new	1015	->new
1135	->fd (fileno $arg{fh})	1016	->fd ($fd)
1136	->events (($arg{poll} =~ /r/ ? 1 : 0)	1017	->events (($arg{poll} =~ /r/ ? 1 : 0)
1137	\| ($arg{poll} =~ /w/ ? 2 : 0))	1018	\| ($arg{poll} =~ /w/ ? 2 : 0))
1138	->start	1019	->start
1139	->cb (sub {	1020	->cb ($cb)
1140	$cb->(($_[1] & 1 ? 'r' : '')
1141	. ($_[1] & 2 ? 'w' : ''));
1142	})],
1143	urxvt::anyevent::	1021	], urxvt::anyevent::
		1022	}
		1023
		1024	sub idle {
		1025	my ($class, %arg) = @_;
		1026
		1027	my $cb = $arg{cb};
		1028
		1029	urxvt::iw
		1030	->new
		1031	->start
		1032	->cb ($cb)
		1033	}
		1034
		1035	sub child {
		1036	my ($class, %arg) = @_;
		1037
		1038	my $cb = $arg{cb};
		1039
		1040	urxvt::pw
		1041	->new
		1042	->start ($arg{pid})
		1043	->cb (sub {
		1044	$_[0]->stop; # need to cancel manually
		1045	$cb->($_[0]->rpid, $_[0]->rstatus);
		1046	})
1144	}	1047	}
1145		1048
1146	sub DESTROY {	1049	sub DESTROY {
1147	$_[0][1]->stop;	1050	$_[0][1]->stop;
1148	}	1051	}
1149		1052
		1053	# only needed for AnyEvent < 6 compatibility
1150	sub one_event {	1054	sub one_event {
1151	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1055	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1152	}	1056	}
1153		1057
1154	package urxvt::term;	1058	package urxvt::term;
…		…
1169	urxvt::verbose 6, "register package $pkg to $self";	1073	urxvt::verbose 6, "register package $pkg to $self";
1170		1074
1171	@{"$pkg\::ISA"} = urxvt::term::extension::;	1075	@{"$pkg\::ISA"} = urxvt::term::extension::;
1172		1076
1173	my $proxy = bless {	1077	my $proxy = bless {
1174	_pkg => $pkg,	1078	_pkg => $pkg,
		1079	_name => ${"$pkg\::_NAME"}, # hackish
1175	argv => $argv,	1080	argv => $argv,
1176	}, $pkg;	1081	}, $pkg;
1177	Scalar::Util::weaken ($proxy->{term} = $self);	1082	Scalar::Util::weaken ($proxy->{term} = $self);
1178		1083
1179	$self->{_pkg}{$pkg} = $proxy;	1084	$self->{_pkg}{$pkg} = $proxy;
1180		1085
…		…
1183	$proxy->enable ($name => $ref);	1088	$proxy->enable ($name => $ref);
1184	}	1089	}
1185	}	1090	}
1186	}	1091	}
1187		1092
		1093	sub perl_libdirs {
		1094	map { split /:/ }
		1095	$_[0]->resource ("perl_lib"),
		1096	$ENV{URXVT_PERL_LIB},
		1097	"$ENV{HOME}/.urxvt/ext",
		1098	"$LIBDIR/perl"
		1099	}
		1100
		1101	# scan for available extensions and collect their metadata
		1102	sub scan_extensions {
		1103	my ($self) = @_;
		1104
		1105	return if exists $self->{meta};
		1106
		1107	my @libdirs = perl_libdirs $self;
		1108
		1109	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1110
		1111	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1112	$self->{meta} = \my %meta;
		1113
		1114	# first gather extensions
		1115	for my $dir (reverse @libdirs) {
		1116	opendir my $fh, $dir
		1117	or next;
		1118	for my $ext (readdir $fh) {
		1119	$ext !~ /^\./
		1120	and open my $fh, "<", "$dir/$ext"
		1121	or next;
		1122
		1123	my %ext = (dir => $dir);
		1124
		1125	while (<$fh>) {
		1126	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1127	my ($pattern, $type, $desc) = split /:/, $1;
		1128	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1129	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1130	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1131	} else {
		1132	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1133	}
		1134	} elsif (/^#:META:BINDING:(.*)/) {
		1135	my ($keysym, $action) = split /:/, $1;
		1136	$ext{binding}{$keysym} = [$ext, $action];
		1137	} elsif (/^\s*(?:#\|$)/) {
		1138	# skip other comments and empty lines
		1139	} else {
		1140	last; # stop parsing on first non-empty non-comment line
		1141	}
		1142	}
		1143
		1144	$meta{ext}{$ext} = \%ext;
		1145	}
		1146	}
		1147
		1148	# and now merge resources and bindings
		1149	while (my ($k, $v) = each %{ $meta{ext} }) {
		1150	#TODO: should check for extensions overriding each other
		1151	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1152	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1153	}
		1154	}
		1155
1188	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1156	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1189		1157
1190	Creates a new terminal, very similar as if you had started it with system	1158	Creates a new terminal, very similar as if you had started it with system
1191	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1159	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1192	hash which defines the environment of the new terminal.	1160	hash which defines the environment of the new terminal.
…		…
1209	}	1177	}
1210		1178
1211	=item $term->destroy	1179	=item $term->destroy
1212		1180
1213	Destroy the terminal object (close the window, free resources	1181	Destroy the terminal object (close the window, free resources
1214	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1182	etc.). Please note that urxvt will not exit as long as any event
1215	watchers (timers, io watchers) are still active.	1183	watchers (timers, io watchers) are still active.
1216		1184
1217	=item $term->exec_async ($cmd[, @args])	1185	=item $term->exec_async ($cmd[, @args])
1218		1186
1219	Works like the combination of the C<fork>/C<exec> builtins, which executes	1187	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1246	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1214	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1247		1215
1248	Here is a likely non-exhaustive list of option names, please see the	1216	Here is a likely non-exhaustive list of option names, please see the
1249	source file F</src/optinc.h> to see the actual list:	1217	source file F</src/optinc.h> to see the actual list:
1250		1218
1251	borderLess console cursorBlink cursorUnderline hold iconic insecure	1219	borderLess buffered console cursorBlink cursorUnderline hold iconic
1252	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1220	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1253	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1221	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1254	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1222	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1255	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1223	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1256	transparent tripleclickwords utmpInhibit visualBell	1224	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1225	urgentOnBell utmpInhibit visualBell
1257		1226
1258	=item $value = $term->resource ($name[, $newval])	1227	=item $value = $term->resource ($name[, $newval])
1259		1228
1260	Returns the current resource value associated with a given name and	1229	Returns the current resource value associated with a given name and
1261	optionally sets a new value. Setting values is most useful in the C<init>	1230	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1274		1243
1275	Here is a likely non-exhaustive list of resource names, not all of which	1244	Here is a likely non-exhaustive list of resource names, not all of which
1276	are supported in every build, please see the source file F</src/rsinc.h>	1245	are supported in every build, please see the source file F</src/rsinc.h>
1277	to see the actual list:	1246	to see the actual list:
1278		1247
1279	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1248	answerbackstring backgroundPixmap backspace_key blurradius
1280	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1249	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1281	display_name embed ext_bwidth fade font geometry hold iconName	1250	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1282	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1251	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1252	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1283	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1253	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1284	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1254	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1285	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1255	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1286	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1256	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1287	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1257	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1288	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1258	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1289	secondaryScreen secondaryScroll shade term_name title	1259	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1290	transient_for transparent transparent_all tripleclickwords utmpInhibit	1260	term_name title transient_for transparent tripleclickwords urgentOnBell
1291	visualBell	1261	utmpInhibit visualBell
1292		1262
1293	=cut	1263	=cut
1294		1264
1295	sub resource($$;$) {	1265	sub resource($$;$) {
1296	my ($self, $name) = (shift, shift);	1266	my ($self, $name) = (shift, shift);
…		…
1303	Returns the X-Resource for the given pattern, excluding the program or	1273	Returns the X-Resource for the given pattern, excluding the program or
1304	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1274	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1305	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1275	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1306	resource with that pattern exists.	1276	resource with that pattern exists.
1307		1277
		1278	Extensions that define extra resource or command line arguments also need
		1279	to call this method to access their values.
		1280
		1281	If the method is called on an extension object (basically, from an
		1282	extension), then the special prefix C<%.> will be replaced by the name of
		1283	the extension and a dot, and the lone string C<%> will be replaced by the
		1284	extension name itself. This makes it possible to code extensions so you
		1285	can rename them and get a new set of commandline switches and resources
		1286	without having to change the actual code.
		1287
1308	This method should only be called during the C<on_start> hook, as there is	1288	This method should only be called during the C<on_start> hook, as there is
1309	only one resource database per display, and later invocations might return	1289	only one resource database per display, and later invocations might return
1310	the wrong resources.	1290	the wrong resources.
1311		1291
1312	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1292	=item $value = $term->x_resource_boolean ($pattern)
1313		1293
		1294	Like C<x_resource>, above, but interprets the string value as a boolean
		1295	and returns C<1> for true values, C<0> for false values and C<undef> if
		1296	the resource or option isn't specified.
		1297
		1298	You should always use this method to parse boolean resources.
		1299
		1300	=cut
		1301
		1302	sub x_resource_boolean {
		1303	my $res = &x_resource;
		1304
		1305	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1306	}
		1307
		1308	=item $success = $term->bind_action ($key, $octets)
		1309
1314	Adds a keymap translation exactly as specified via a resource. See the	1310	Adds a key binding exactly as specified via a C<keysym> resource. See the
1315	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1311	C<keysym> resource in the urxvt(1) manpage.
1316		1312
1317	=item $rend = $term->rstyle ([$new_rstyle])	1313	=item $rend = $term->rstyle ([$new_rstyle])
1318		1314
1319	Return and optionally change the current rendition. Text that is output by	1315	Return and optionally change the current rendition. Text that is output by
1320	the terminal application will use this style.	1316	the terminal application will use this style.
…		…
1328		1324
1329	=item ($row, $col) = $term->selection_beg ([$row, $col])	1325	=item ($row, $col) = $term->selection_beg ([$row, $col])
1330		1326
1331	=item ($row, $col) = $term->selection_end ([$row, $col])	1327	=item ($row, $col) = $term->selection_end ([$row, $col])
1332		1328
1333	Return the current values of the selection mark, begin or end positions,	1329	Return the current values of the selection mark, begin or end positions.
1334	and optionally set them to new values.	1330
		1331	When arguments are given, then the selection coordinates are set to
		1332	C<$row> and C<$col>, and the selection screen is set to the current
		1333	screen.
		1334
		1335	=item $screen = $term->selection_screen ([$screen])
		1336
		1337	Returns the current selection screen, and then optionally sets it.
1335		1338
1336	=item $term->selection_make ($eventtime[, $rectangular])	1339	=item $term->selection_make ($eventtime[, $rectangular])
1337		1340
1338	Tries to make a selection as set by C<selection_beg> and	1341	Tries to make a selection as set by C<selection_beg> and
1339	C<selection_end>. If C<$rectangular> is true (default: false), a	1342	C<selection_end>. If C<$rectangular> is true (default: false), a
1340	rectangular selection will be made. This is the prefered function to make	1343	rectangular selection will be made. This is the preferred function to make
1341	a selection.	1344	a selection.
1342		1345
1343	=item $success = $term->selection_grab ($eventtime)	1346	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1344		1347
1345	Try to request the primary selection text from the server (for example, as	1348	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1349	true) selection from the server. The corresponding text can be set
1346	set by the next method). No visual feedback will be given. This function	1350	with the next method. No visual feedback will be given. This function
1347	is mostly useful from within C<on_sel_grab> hooks.	1351	is mostly useful from within C<on_sel_grab> hooks.
1348		1352
1349	=item $oldtext = $term->selection ([$newtext])	1353	=item $oldtext = $term->selection ([$newtext, $clipboard])
1350		1354
1351	Return the current selection text and optionally replace it by C<$newtext>.	1355	Return the current selection (clipboard if C<$clipboard> is true) text
		1356	and optionally replace it by C<$newtext>.
		1357
		1358	=item $term->selection_clear ([$clipboard])
		1359
		1360	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1352		1361
1353	=item $term->overlay_simple ($x, $y, $text)	1362	=item $term->overlay_simple ($x, $y, $text)
1354		1363
1355	Create a simple multi-line overlay box. See the next method for details.	1364	Create a simple multi-line overlay box. See the next method for details.
1356		1365
…		…
1484	locale-specific encoding of the terminal and can contain command sequences	1493	locale-specific encoding of the terminal and can contain command sequences
1485	(escape codes) that will be interpreted.	1494	(escape codes) that will be interpreted.
1486		1495
1487	=item $term->tt_write ($octets)	1496	=item $term->tt_write ($octets)
1488		1497
1489	Write the octets given in C<$data> to the tty (i.e. as program input). To	1498	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1490	pass characters instead of octets, you should convert your strings first	1499	pass characters instead of octets, you should convert your strings first
1491	to the locale-specific encoding using C<< $term->locale_encode >>.	1500	to the locale-specific encoding using C<< $term->locale_encode >>.
		1501
		1502	=item $term->tt_write_user_input ($octets)
		1503
		1504	Like C<tt_write>, but should be used when writing strings in response to
		1505	the user pressing a key, to invoke the additional actions requested by
		1506	the user for that case (C<tt_write> doesn't do that).
		1507
		1508	The typical use case would be inside C<on_action> hooks.
		1509
		1510	=item $term->tt_paste ($octets)
		1511
		1512	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1513	CR and bracketing the data with control sequences if bracketed paste mode
		1514	is set.
1492		1515
1493	=item $old_events = $term->pty_ev_events ([$new_events])	1516	=item $old_events = $term->pty_ev_events ([$new_events])
1494		1517
1495	Replaces the event mask of the pty watcher by the given event mask. Can	1518	Replaces the event mask of the pty watcher by the given event mask. Can
1496	be used to suppress input and output handling to the pty/tty. See the	1519	be used to suppress input and output handling to the pty/tty. See the
…		…
1514		1537
1515	Adds the specified events to the vt event mask. Useful e.g. when you want	1538	Adds the specified events to the vt event mask. Useful e.g. when you want
1516	to receive pointer events all the times:	1539	to receive pointer events all the times:
1517		1540
1518	$term->vt_emask_add (urxvt::PointerMotionMask);	1541	$term->vt_emask_add (urxvt::PointerMotionMask);
		1542
		1543	=item $term->set_urgency ($set)
		1544
		1545	Enable/disable the urgency hint on the toplevel window.
1519		1546
1520	=item $term->focus_in	1547	=item $term->focus_in
1521		1548
1522	=item $term->focus_out	1549	=item $term->focus_out
1523		1550
…		…
1720	}	1747	}
1721		1748
1722	sub urxvt::line::t {	1749	sub urxvt::line::t {
1723	my ($self) = @_;	1750	my ($self) = @_;
1724		1751
1725	if (@_ > 1)	1752	if (@_ > 1) {
1726	{
1727	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1753	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1728	for $self->{beg} .. $self->{end};	1754	for $self->{beg} .. $self->{end};
1729	}	1755	}
1730		1756
1731	defined wantarray &&	1757	defined wantarray &&
1732	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1758	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1733	0, $self->{len}	1759	0, $self->{len}
1734	}	1760	}
1735		1761
1736	sub urxvt::line::r {	1762	sub urxvt::line::r {
1737	my ($self) = @_;	1763	my ($self) = @_;
1738		1764
1739	if (@_ > 1)	1765	if (@_ > 1) {
1740	{
1741	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1766	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1742	for $self->{beg} .. $self->{end};	1767	for $self->{beg} .. $self->{end};
1743	}	1768	}
1744		1769
1745	if (defined wantarray) {	1770	if (defined wantarray) {
1746	my $rend = [	1771	my $rend = [
1747	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1772	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1748	];	1773	];
…		…
1810	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1835	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1811	recent grab.	1836	recent grab.
1812		1837
1813	=item $term->ungrab	1838	=item $term->ungrab
1814		1839
1815	Calls XUngrab for the most recent grab. Is called automatically on	1840	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1816	evaluation errors, as it is better to lose the grab in the error case as	1841	evaluation errors, as it is better to lose the grab in the error case as
1817	the session.	1842	the session.
1818		1843
1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1844	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820		1845
…		…
1840		1865
1841	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1866	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1842		1867
1843	=item $term->XChangeInput ($window, $add_events[, $del_events])	1868	=item $term->XChangeInput ($window, $add_events[, $del_events])
1844		1869
		1870	=item $keysym = $term->XStringToKeysym ($string)
		1871
		1872	=item $string = $term->XKeysymToString ($keysym)
		1873
1845	Various X or X-related functions. The C<$term> object only serves as	1874	Various X or X-related functions. The C<$term> object only serves as
1846	the source of the display, otherwise those functions map more-or-less	1875	the source of the display, otherwise those functions map more-or-less
1847	directory onto the X functions of the same name.	1876	directly onto the X functions of the same name.
1848		1877
1849	=back	1878	=back
1850		1879
1851	=cut	1880	=cut
1852		1881
…		…
2009		2038
2010	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2039	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011		2040
2012	Set the callback to be called when the timer triggers.	2041	Set the callback to be called when the timer triggers.
2013		2042
2014	=item $tstamp = $timer->at
2015
2016	Return the time this watcher will fire next.
2017
2018	=item $timer = $timer->set ($tstamp)	2043	=item $timer = $timer->set ($tstamp[, $interval])
2019		2044
2020	Set the time the event is generated to $tstamp.	2045	Set the time the event is generated to $tstamp (and optionally specifies a
		2046	new $interval).
2021		2047
2022	=item $timer = $timer->interval ($interval)	2048	=item $timer = $timer->interval ($interval)
2023		2049
2024	Normally (and when C<$interval> is C<0>), the timer will automatically	2050	By default (and when C<$interval> is C<0>), the timer will automatically
2025	stop after it has fired once. If C<$interval> is non-zero, then the timer	2051	stop after it has fired once. If C<$interval> is non-zero, then the timer
2026	is automatically rescheduled at the given intervals.	2052	is automatically rescheduled at the given intervals.
2027		2053
2028	=item $timer = $timer->start	2054	=item $timer = $timer->start
2029		2055
2030	Start the timer.	2056	Start the timer.
2031		2057
2032	=item $timer = $timer->start ($tstamp)	2058	=item $timer = $timer->start ($tstamp[, $interval])
2033		2059
2034	Set the event trigger time to C<$tstamp> and start the timer.	2060	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2061	also replaces the interval.
2035		2062
2036	=item $timer = $timer->after ($delay)	2063	=item $timer = $timer->after ($delay[, $interval])
2037		2064
2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2065	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2039		2066
2040	=item $timer = $timer->stop	2067	=item $timer = $timer->stop
2041		2068
…		…
2172		2199
2173	=back	2200	=back
2174		2201
2175	=head1 AUTHOR	2202	=head1 AUTHOR
2176		2203
2177	Marc Lehmann <pcg@goof.com>	2204	Marc Lehmann <schmorp@schmorp.de>
2178	http://software.schmorp.de/pkg/rxvt-unicode	2205	http://software.schmorp.de/pkg/rxvt-unicode
2179		2206
2180	=cut	2207	=cut
2181		2208
2182	1	2209	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.172 by root, Fri Oct 10 00:21:15 2008 UTC vs. Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.172 by root, Fri Oct 10 00:21:15 2008 UTC vs.
Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 2014 UTC