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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.179 by root, Sat Dec 26 09:23:53 2009 UTC vs.
Revision 1.242 by sf-exg, Sat Oct 11 20:46:36 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 resources on their own. Similarly to builtin
48		49	resources, these resources can also be specified on the command line
49	=item selection (enabled by default)	50	as long options (with '.' replaced by '-'), in which case the
50		51	corresponding extension is loaded automatically.
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 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 wether xrdb is used to parse the resource file
376	or not.
377
378	=item macosx-pastebin and macosx-pastebin-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<maxosx-pastebin> 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	=back
399		52
400	=head1 API DOCUMENTATION	53	=head1 API DOCUMENTATION
401		54
402	=head2 General API Considerations	55	=head2 General API Considerations
403		56
417		70
418	=over 4	71	=over 4
419		72
420	=item $text	73	=item $text
421		74
422	Rxvt-unicodes special way of encoding text, where one "unicode" character	75	Rxvt-unicode's special way of encoding text, where one "unicode" character
423	always represents one screen cell. See L<ROW_t> for a discussion of this format.	76	always represents one screen cell. See L<ROW_t> for a discussion of this format.
424		77
425	=item $string	78	=item $string
426		79
427	A perl text string, with an emphasis on I<text>. It can store all unicode	80	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
431	=item $octets	84	=item $octets
432		85
433	Either binary data or - more common - a text string encoded in a	86	Either binary data or - more common - a text string encoded in a
434	locale-specific way.	87	locale-specific way.
435		88
		89	=item $keysym
		90
		91	an integer that is a valid X11 keysym code. You can convert a string
		92	into a keysym and viceversa by using C<XStringToKeysym> and
		93	C<XKeysymToString>.
		94
436	=back	95	=back
437		96
438	=head2 Extension Objects	97	=head2 Extension Objects
439		98
440	Every perl extension is a perl class. A separate perl object is created	99	Every perl extension is a perl class. A separate perl object is created
441	for each terminal, and each terminal has its own set of extenion objects,	100	for each terminal, and each terminal has its own set of extension objects,
442	which are passed as the first parameter to hooks. So extensions can use	101	which are passed as the first parameter to hooks. So extensions can use
443	their C<$self> object without having to think about clashes with other	102	their C<$self> object without having to think about clashes with other
444	extensions or other terminals, with the exception of methods and members	103	extensions or other terminals, with the exception of methods and members
445	that begin with an underscore character C<_>: these are reserved for	104	that begin with an underscore character C<_>: these are reserved for
446	internal use.	105	internal use.
447		106
448	Although it isn't a C<urxvt::term> object, you can call all methods of the	107	Although it isn't a C<urxvt::term> object, you can call all methods of the
449	C<urxvt::term> class on this object.	108	C<urxvt::term> class on this object.
450		109
451	It has the following methods and data members:	110	Additional methods only supported for extension objects are described in
452		111	the C<urxvt::extension> section below.
453	=over 4
454
455	=item $urxvt_term = $self->{term}
456
457	Returns the C<urxvt::term> object associated with this instance of the
458	extension. This member I<must not> be changed in any way.
459
460	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
461
462	Dynamically enable the given hooks (named without the C<on_> prefix) for
463	this extension, replacing any previous hook. This is useful when you want
464	to overwrite time-critical hooks only temporarily.
465
466	=item $self->disable ($hook_name[, $hook_name..])
467
468	Dynamically disable the given hooks.
469
470	=back
471		112
472	=head2 Hooks	113	=head2 Hooks
473		114
474	The following subroutines can be declared in extension files, and will be	115	The following subroutines can be declared in extension files, and will be
475	called whenever the relevant event happens.	116	called whenever the relevant event happens.
…		…
610	=item on_tt_write $term, $octets	251	=item on_tt_write $term, $octets
611		252
612	Called whenever some data is written to the tty/pty and can be used to	253	Called whenever some data is written to the tty/pty and can be used to
613	suppress or filter tty input.	254	suppress or filter tty input.
614		255
		256	=item on_tt_paste $term, $octets
		257
		258	Called whenever text is about to be pasted, with the text as argument. You
		259	can filter/change and paste the text yourself by returning a true value
		260	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		261	locale-encoded.
		262
615	=item on_line_update $term, $row	263	=item on_line_update $term, $row
616		264
617	Called whenever a line was updated or changed. Can be used to filter	265	Called whenever a line was updated or changed. Can be used to filter
618	screen output (e.g. underline urls or other useless stuff). Only lines	266	screen output (e.g. underline urls or other useless stuff). Only lines
619	that are being shown will be filtered, and, due to performance reasons,	267	that are being shown will be filtered, and, due to performance reasons,
…		…
635		283
636	=item on_refresh_end $term	284	=item on_refresh_end $term
637		285
638	Called just after the screen gets redrawn. See C<on_refresh_begin>.	286	Called just after the screen gets redrawn. See C<on_refresh_begin>.
639		287
640	=item on_user_command $term, $string	288	=item on_user_command $term, $string DEPRECATED
641		289
642	Called whenever a user-configured event is being activated (e.g. via	290	Called whenever a user-configured event is being activated (e.g. via
643	a C<perl:string> action bound to a key, see description of the B<keysym>	291	a C<perl:string> action bound to a key, see description of the B<keysym>
644	resource in the @@RXVT_NAME@@(1) manpage).	292	resource in the urxvt(1) manpage).
645		293
646	The event is simply the action string. This interface is assumed to change	294	The event is simply the action string. This interface is going away in
647	slightly in the future.	295	preference to the C<on_action> hook.
648		296
649	=item on_resize_all_windows $tern, $new_width, $new_height	297	=item on_resize_all_windows $term, $new_width, $new_height
650		298
651	Called just after the new window size has been calculated, but before	299	Called just after the new window size has been calculated, but before
652	windows are actually being resized or hints are being set. If this hook	300	windows are actually being resized or hints are being set. If this hook
653	returns TRUE, setting of the window hints is being skipped.	301	returns a true value, setting of the window hints is being skipped.
654		302
655	=item on_x_event $term, $event	303	=item on_x_event $term, $event
656		304
657	Called on every X event received on the vt window (and possibly other	305	Called on every X event received on the vt window (and possibly other
658	windows). Should only be used as a last resort. Most event structure	306	windows). Should only be used as a last resort. Most event structure
…		…
688		336
689	=item on_map_notify $term, $event	337	=item on_map_notify $term, $event
690		338
691	=item on_unmap_notify $term, $event	339	=item on_unmap_notify $term, $event
692		340
693	Called whenever the corresponding X event is received for the terminal If	341	Called whenever the corresponding X event is received for the terminal. If
694	the hook returns true, then the even will be ignored by rxvt-unicode.	342	the hook returns true, then the event will be ignored by rxvt-unicode.
695		343
696	The event is a hash with most values as named by Xlib (see the XEvent	344	The event is a hash with most values as named by Xlib (see the XEvent
697	manpage), with the additional members C<row> and C<col>, which are the	345	manpage), with the additional members C<row> and C<col>, which are the
698	(real, not screen-based) row and column under the mouse cursor.	346	(real, not screen-based) row and column under the mouse cursor.
699		347
700	C<on_key_press> additionally receives the string rxvt-unicode would	348	C<on_key_press> additionally receives the string rxvt-unicode would
701	output, if any, in locale-specific encoding.	349	output, if any, in locale-specific encoding.
702		350
703	subwindow.
704
705	=item on_client_message $term, $event	351	=item on_client_message $term, $event
706		352
707	=item on_wm_protocols $term, $event	353	=item on_wm_protocols $term, $event
708		354
709	=item on_wm_delete_window $term, $event	355	=item on_wm_delete_window $term, $event
710		356
711	Called when various types of ClientMessage events are received (all with	357	Called when various types of ClientMessage events are received (all with
712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	358	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
713		359
		360	=item on_bell $term
		361
		362	Called on receipt of a bell character.
		363
714	=back	364	=back
715		365
716	=cut	366	=cut
717		367
718	package urxvt;	368	package urxvt;
719		369
720	use utf8;	370	use utf8;
721	use strict;	371	use strict 'vars';
722	use Carp ();	372	use Carp ();
723	use Scalar::Util ();	373	use Scalar::Util ();
724	use List::Util ();	374	use List::Util ();
725		375
726	our $VERSION = 1;	376	our $VERSION = 1;
727	our $TERM;	377	our $TERM;
728	our @TERM_INIT;	378	our @TERM_INIT; # should go, prevents async I/O etc.
729	our @TERM_EXT;	379	our @TERM_EXT; # should go, prevents async I/O etc.
730	our @HOOKNAME;	380	our @HOOKNAME;
731	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	381	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
732	our %OPTION;	382	our %OPTION;
733		383
734	our $LIBDIR;	384	our $LIBDIR;
…		…
782		432
783	=over 4	433	=over 4
784		434
785	=item urxvt::fatal $errormessage	435	=item urxvt::fatal $errormessage
786		436
787	Fatally aborts execution with the given error message. Avoid at all	437	Fatally aborts execution with the given error message (which should
788	costs! The only time this is acceptable is when the terminal process	438	include a trailing newline). Avoid at all costs! The only time this
789	starts up.	439	is acceptable (and useful) is in the init hook, where it prevents the
		440	terminal from starting up.
790		441
791	=item urxvt::warn $string	442	=item urxvt::warn $string
792		443
793	Calls C<rxvt_warn> with the given string which should not include a	444	Calls C<rxvt_warn> with the given string which should include a trailing
794	newline. The module also overwrites the C<warn> builtin with a function	445	newline. The module also overwrites the C<warn> builtin with a function
795	that calls this function.	446	that calls this function.
796		447
797	Using this function has the advantage that its output ends up in the	448	Using this function has the advantage that its output ends up in the
798	correct place, e.g. on stderr of the connecting urxvtc client.	449	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
802	=item @terms = urxvt::termlist	453	=item @terms = urxvt::termlist
803		454
804	Returns all urxvt::term objects that exist in this process, regardless of	455	Returns all urxvt::term objects that exist in this process, regardless of
805	whether they are started, being destroyed etc., so be careful. Only term	456	whether they are started, being destroyed etc., so be careful. Only term
806	objects that have perl extensions attached will be returned (because there	457	objects that have perl extensions attached will be returned (because there
807	is no urxvt::term objet associated with others).	458	is no urxvt::term object associated with others).
808		459
809	=item $time = urxvt::NOW	460	=item $time = urxvt::NOW
810		461
811	Returns the "current time" (as per the event loop).	462	Returns the "current time" (as per the event loop).
812		463
…		…
855		506
856	=item $rend = urxvt::OVERLAY_RSTYLE	507	=item $rend = urxvt::OVERLAY_RSTYLE
857		508
858	Return the rendition mask used for overlays by default.	509	Return the rendition mask used for overlays by default.
859		510
860	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	511	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		512	urxvt::RS_RVid, urxvt::RS_Uline
861		513
862	Return the bit that enabled bold, italic, blink, reverse-video and	514	Return the bit that enabled bold, italic, blink, reverse-video and
863	underline, respectively. To enable such a style, just logically OR it into	515	underline, respectively. To enable such a style, just logically OR it into
864	the bitset.	516	the bitset.
865		517
…		…
902	};	554	};
903	}	555	}
904		556
905	no warnings 'utf8';	557	no warnings 'utf8';
906		558
		559	sub parse_resource {
		560	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		561
		562	$term->scan_extensions;
		563
		564	my $r = $term->{meta}{resource};
		565	keys %$r; # reset iterator
		566	while (my ($k, $v) = each %$r) {
		567	my $pattern = $k;
		568	$pattern =~ y/./-/ if $isarg;
		569	my $prefix = $name;
		570	my $suffix;
		571	if ($pattern =~ /\-$/) {
		572	$prefix = substr $name, 0, length $pattern;
		573	$suffix = substr $name, length $pattern;
		574	}
		575	if ($pattern eq $prefix) {
		576	$name = "$urxvt::RESCLASS.$k$suffix";
		577
		578	push @{ $term->{perl_ext_3} }, $v->[0];
		579
		580	if ($v->[1] eq "boolean") {
		581	$term->put_option_db ($name, $flag ? "true" : "false");
		582	return 1;
		583	} else {
		584	$term->put_option_db ($name, $value);
		585	return 1 + 2;
		586	}
		587	}
		588	}
		589
		590	0
		591	}
		592
		593	sub usage {
		594	my ($term, $usage_type) = @_;
		595
		596	$term->scan_extensions;
		597
		598	my $r = $term->{meta}{resource};
		599
		600	for my $pattern (sort keys %$r) {
		601	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		602
		603	$desc .= " (-pe $ext)";
		604
		605	if ($usage_type == 1) {
		606	$pattern =~ y/./-/;
		607	$pattern =~ s/-$/-.../g;
		608
		609	if ($type eq "boolean") {
		610	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		611	} else {
		612	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		613	}
		614	} else {
		615	$pattern =~ s/\.$/.*/g;
		616	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		617	}
		618	}
		619	}
		620
907	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	621	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
908		622
909	sub verbose {	623	sub verbose {
910	my ($level, $msg) = @_;	624	my ($level, $msg) = @_;
911	warn "$msg\n" if $level <= $verbosity;	625	warn "$msg\n" if $level <= $verbosity;
…		…
923	$pkg =~ s/[^[:word:]]/_/g;	637	$pkg =~ s/[^[:word:]]/_/g;
924	$pkg = "urxvt::ext::$pkg";	638	$pkg = "urxvt::ext::$pkg";
925		639
926	verbose 3, "loading extension '$path' into package '$pkg'";	640	verbose 3, "loading extension '$path' into package '$pkg'";
927		641
		642	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		643
928	open my $fh, "<:raw", $path	644	open my $fh, "<:raw", $path
929	or die "$path: $!";	645	or die "$path: $!";
930		646
931	my $source =	647	my $source =
932	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	648	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
933	. "#line 1 \"$path\"\n{\n"	649	. "#line 1 \"$path\"\n{\n"
934	. (do { local $/; <$fh> })	650	. (do { local $/; <$fh> })
935	. "\n};\n1";	651	. "\n};\n1";
936		652
937	eval $source	653	eval $source
…		…
946	# called by the rxvt core	662	# called by the rxvt core
947	sub invoke {	663	sub invoke {
948	local $TERM = shift;	664	local $TERM = shift;
949	my $htype = shift;	665	my $htype = shift;
950		666
951	if ($htype == 0) { # INIT	667	if ($htype == HOOK_INIT) {
952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	668	my @dirs = $TERM->perl_libdirs;
		669
		670	$TERM->scan_extensions;
953		671
954	my %ext_arg;	672	my %ext_arg;
955		673
956	{	674	{
957	my @init = @TERM_INIT;	675	my @init = @TERM_INIT;
…		…
960	my @pkg = @TERM_EXT;	678	my @pkg = @TERM_EXT;
961	@TERM_EXT = ();	679	@TERM_EXT = ();
962	$TERM->register_package ($_) for @pkg;	680	$TERM->register_package ($_) for @pkg;
963	}	681	}
964		682
		683	for (
965	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	684	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		685	) {
966	if ($_ eq "default") {	686	if ($_ eq "default") {
967	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	687
		688	$ext_arg{$_} = []
		689	for
		690	qw(selection option-popup selection-popup readline),
		691	@{ delete $TERM->{perl_ext_3} },
		692	map $_->[0], values %{ $TERM->{meta}{binding} };
		693
		694	for ($TERM->_keysym_resources) {
		695	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		696	next unless /^([A-Za-z0-9_\-]+):/;
		697
		698	my $ext = $1;
		699
		700	$ext_arg{$ext} = [];
		701	}
		702
968	} elsif (/^-(.*)$/) {	703	} elsif (/^-(.*)$/) {
969	delete $ext_arg{$1};	704	delete $ext_arg{$1};
		705
970	} elsif (/^([^<]+)<(.*)>$/) {	706	} elsif (/^([^<]+)<(.*)>$/) {
971	push @{ $ext_arg{$1} }, $2;	707	push @{ $ext_arg{$1} }, $2;
		708
972	} else {	709	} else {
973	$ext_arg{$_} \|\|= [];	710	$ext_arg{$_} \|\|= [];
		711	}
		712	}
		713
		714	# now register default key bindings
		715	for my $ext (sort keys %ext_arg) {
		716	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		717	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
974	}	718	}
975	}	719	}
976		720
977	for my $ext (sort keys %ext_arg) {	721	for my $ext (sort keys %ext_arg) {
978	my @files = grep -f $_, map "$_/$ext", @dirs;	722	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
992		736
993	if (my $cb = $TERM->{_hook}[$htype]) {	737	if (my $cb = $TERM->{_hook}[$htype]) {
994	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	738	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
995	if $verbosity >= 10;	739	if $verbosity >= 10;
996		740
		741	if ($htype == HOOK_ACTION) {
		742	# this hook is only sent to the extension with the name
		743	# matching the first arg
		744	my $pkg = shift;
		745	$pkg =~ y/-/_/;
		746	$pkg = "urxvt::ext::$pkg";
		747
		748	$cb = $cb->{$pkg}
		749	or return undef; #TODO: maybe warn user?
		750
		751	$cb = { $pkg => $cb };
		752	}
		753
997	for my $pkg (keys %$cb) {	754	for my $pkg (keys %$cb) {
998	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	755	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
999	$retval \|\|= $retval_;	756	$retval \|\|= $retval_;
1000		757
1001	if ($@) {	758	if ($@) {
1002	$TERM->ungrab; # better to lose the grab than the session	759	$TERM->ungrab; # better to lose the grab than the session
1003	warn $@;	760	warn $@;
…		…
1006		763
1007	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	764	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1008	if $verbosity >= 11;	765	if $verbosity >= 11;
1009	}	766	}
1010		767
1011	if ($htype == 1) { # DESTROY	768	if ($htype == HOOK_DESTROY) {
1012	# clear package objects	769	# clear package objects
1013	%$_ = () for values %{ $TERM->{_pkg} };	770	%$_ = () for values %{ $TERM->{_pkg} };
1014		771
1015	# clear package	772	# clear package
1016	%$TERM = ();	773	%$TERM = ();
…		…
1046	}	803	}
1047	}	804	}
1048	($mask, @color{qw(fg bg)}, \@failed)	805	($mask, @color{qw(fg bg)}, \@failed)
1049	}	806	}
1050		807
1051	# urxvt::term::extension
1052
1053	package urxvt::term::extension;	808	package urxvt::term::extension;
1054		809
1055	sub enable {	810	=head2 The C<urxvt::term::extension> class
1056	my ($self, %hook) = @_;
1057	my $pkg = $self->{_pkg};
1058		811
1059	while (my ($name, $cb) = each %hook) {	812	Each extension attached to a terminal object is represented by
1060	my $htype = $HOOKTYPE{uc $name};	813	a C<urxvt::term::extension> object.
1061	defined $htype
1062	or Carp::croak "unsupported hook type '$name'";
1063		814
1064	$self->set_should_invoke ($htype, +1)	815	You can use these objects, which are passed to all callbacks to store any
1065	unless exists $self->{term}{_hook}[$htype]{$pkg};	816	state related to the terminal and extension instance.
1066		817
1067	$self->{term}{_hook}[$htype]{$pkg} = $cb;	818	The methods (And data members) documented below can be called on extension
1068	}	819	objects, in addition to call methods documented for the <urxvt::term>
1069	}	820	class.
1070		821
1071	sub disable {	822	=over 4
1072	my ($self, @hook) = @_;
1073	my $pkg = $self->{_pkg};
1074		823
1075	for my $name (@hook) {	824	=item $urxvt_term = $self->{term}
1076	my $htype = $HOOKTYPE{uc $name};
1077	defined $htype
1078	or Carp::croak "unsupported hook type '$name'";
1079		825
1080	$self->set_should_invoke ($htype, -1)	826	Returns the C<urxvt::term> object associated with this instance of the
1081	if delete $self->{term}{_hook}[$htype]{$pkg};	827	extension. This member I<must not> be changed in any way.
1082	}	828
1083	}	829	=cut
1084		830
1085	our $AUTOLOAD;	831	our $AUTOLOAD;
1086		832
1087	sub AUTOLOAD {	833	sub AUTOLOAD {
1088	$AUTOLOAD =~ /:([^:]+)$/	834	$AUTOLOAD =~ /:([^:]+)$/
…		…
1101		847
1102	sub DESTROY {	848	sub DESTROY {
1103	# nop	849	# nop
1104	}	850	}
1105		851
1106	# urxvt::destroy_hook	852	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1107		853
1108	sub urxvt::destroy_hook::DESTROY {	854	sub urxvt::destroy_hook::DESTROY {
1109	${$_[0]}->();	855	${$_[0]}->();
1110	}	856	}
1111		857
1112	sub urxvt::destroy_hook(&) {	858	sub urxvt::destroy_hook(&) {
1113	bless \shift, urxvt::destroy_hook::	859	bless \shift, urxvt::destroy_hook::
1114	}	860	}
		861
		862	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		863
		864	Dynamically enable the given hooks (named without the C<on_> prefix) for
		865	this extension, replacing any hook previously installed via C<enable> in
		866	this extension.
		867
		868	This is useful when you want to overwrite time-critical hooks only
		869	temporarily.
		870
		871	To install additional callbacks for the same hook, you can use the C<on>
		872	method of the C<urxvt::term> class.
		873
		874	=item $self->disable ($hook_name[, $hook_name..])
		875
		876	Dynamically disable the given hooks.
		877
		878	=cut
		879
		880	sub enable {
		881	my ($self, %hook) = @_;
		882	my $pkg = $self->{_pkg};
		883
		884	while (my ($name, $cb) = each %hook) {
		885	my $htype = $HOOKTYPE{uc $name};
		886	defined $htype
		887	or Carp::croak "unsupported hook type '$name'";
		888
		889	$self->set_should_invoke ($htype, +1)
		890	unless exists $self->{term}{_hook}[$htype]{$pkg};
		891
		892	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		893	}
		894	}
		895
		896	sub disable {
		897	my ($self, @hook) = @_;
		898	my $pkg = $self->{_pkg};
		899
		900	for my $name (@hook) {
		901	my $htype = $HOOKTYPE{uc $name};
		902	defined $htype
		903	or Carp::croak "unsupported hook type '$name'";
		904
		905	$self->set_should_invoke ($htype, -1)
		906	if delete $self->{term}{_hook}[$htype]{$pkg};
		907	}
		908	}
		909
		910	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		911
		912	Similar to the C<enable> enable, but installs additional callbacks for
		913	the given hook(s) (that is, it doesn't replace existing callbacks), and
		914	returns a guard object. When the guard object is destroyed the callbacks
		915	are disabled again.
		916
		917	=cut
		918
		919	sub urxvt::extension::on_disable::DESTROY {
		920	my $disable = shift;
		921
		922	my $term = delete $disable->{""};
		923
		924	while (my ($htype, $id) = each %$disable) {
		925	delete $term->{_hook}[$htype]{$id};
		926	$term->set_should_invoke ($htype, -1);
		927	}
		928	}
		929
		930	sub on {
		931	my ($self, %hook) = @_;
		932
		933	my $term = $self->{term};
		934
		935	my %disable = ( "" => $term );
		936
		937	while (my ($name, $cb) = each %hook) {
		938	my $htype = $HOOKTYPE{uc $name};
		939	defined $htype
		940	or Carp::croak "unsupported hook type '$name'";
		941
		942	$term->set_should_invoke ($htype, +1);
		943	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		944	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		945	}
		946
		947	bless \%disable, "urxvt::extension::on_disable"
		948	}
		949
		950	=item $self->x_resource ($pattern)
		951
		952	=item $self->x_resource_boolean ($pattern)
		953
		954	These methods support an additional C<%> prefix when called on an
		955	extension object - see the description of these methods in the
		956	C<urxvt::term> class for details.
		957
		958	=cut
		959
		960	sub x_resource {
		961	my ($self, $name) = @_;
		962	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		963	$self->{term}->x_resource ($name)
		964	}
		965
		966	sub x_resource_boolean {
		967	my ($self, $name) = @_;
		968	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		969	$self->{term}->x_resource_boolean ($name)
		970	}
		971
		972	=back
		973
		974	=cut
1115		975
1116	package urxvt::anyevent;	976	package urxvt::anyevent;
1117		977
1118	=head2 The C<urxvt::anyevent> Class	978	=head2 The C<urxvt::anyevent> Class
1119		979
1120	The sole purpose of this class is to deliver an interface to the	980	The sole purpose of this class is to deliver an interface to the
1121	C<AnyEvent> module - any module using it will work inside urxvt without	981	C<AnyEvent> module - any module using it will work inside urxvt without
1122	further programming. The only exception is that you cannot wait on	982	further programming. The only exception is that you cannot wait on
1123	condition variables, but non-blocking condvar use is ok. What this means	983	condition variables, but non-blocking condvar use is ok.
1124	is that you cannot use blocking APIs, but the non-blocking variant should	984
1125	work.	985	In practical terms this means is that you cannot use blocking APIs, but
		986	the non-blocking variant should work.
1126		987
1127	=cut	988	=cut
1128		989
1129	our $VERSION = '5.23';	990	our $VERSION = '5.23';
1130		991
…		…
1189		1050
1190	sub DESTROY {	1051	sub DESTROY {
1191	$_[0][1]->stop;	1052	$_[0][1]->stop;
1192	}	1053	}
1193		1054
		1055	# only needed for AnyEvent < 6 compatibility
1194	sub one_event {	1056	sub one_event {
1195	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1057	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1196	}	1058	}
1197		1059
1198	package urxvt::term;	1060	package urxvt::term;
…		…
1213	urxvt::verbose 6, "register package $pkg to $self";	1075	urxvt::verbose 6, "register package $pkg to $self";
1214		1076
1215	@{"$pkg\::ISA"} = urxvt::term::extension::;	1077	@{"$pkg\::ISA"} = urxvt::term::extension::;
1216		1078
1217	my $proxy = bless {	1079	my $proxy = bless {
1218	_pkg => $pkg,	1080	_pkg => $pkg,
		1081	_name => ${"$pkg\::_NAME"}, # hackish
1219	argv => $argv,	1082	argv => $argv,
1220	}, $pkg;	1083	}, $pkg;
1221	Scalar::Util::weaken ($proxy->{term} = $self);	1084	Scalar::Util::weaken ($proxy->{term} = $self);
1222		1085
1223	$self->{_pkg}{$pkg} = $proxy;	1086	$self->{_pkg}{$pkg} = $proxy;
1224		1087
…		…
1227	$proxy->enable ($name => $ref);	1090	$proxy->enable ($name => $ref);
1228	}	1091	}
1229	}	1092	}
1230	}	1093	}
1231		1094
		1095	sub perl_libdirs {
		1096	map { split /:/ }
		1097	$_[0]->resource ("perl_lib"),
		1098	$ENV{URXVT_PERL_LIB},
		1099	"$ENV{HOME}/.urxvt/ext",
		1100	"$LIBDIR/perl"
		1101	}
		1102
		1103	# scan for available extensions and collect their metadata
		1104	sub scan_extensions {
		1105	my ($self) = @_;
		1106
		1107	return if exists $self->{meta};
		1108
		1109	my @libdirs = perl_libdirs $self;
		1110
		1111	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1112
		1113	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1114	$self->{meta} = \my %meta;
		1115
		1116	# first gather extensions
		1117	for my $dir (reverse @libdirs) {
		1118	opendir my $fh, $dir
		1119	or next;
		1120	for my $ext (readdir $fh) {
		1121	$ext !~ /^\./
		1122	and open my $fh, "<", "$dir/$ext"
		1123	or next;
		1124
		1125	my %ext = (dir => $dir);
		1126
		1127	while (<$fh>) {
		1128	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1129	my ($pattern, $type, $desc) = split /:/, $1;
		1130	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1131	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1132	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1133	} else {
		1134	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1135	}
		1136	} elsif (/^#:META:BINDING:(.*)/) {
		1137	my ($keysym, $action) = split /:/, $1;
		1138	$ext{binding}{$keysym} = [$ext, $action];
		1139	} elsif (/^\s*(?:#\|$)/) {
		1140	# skip other comments and empty lines
		1141	} else {
		1142	last; # stop parsing on first non-empty non-comment line
		1143	}
		1144	}
		1145
		1146	$meta{ext}{$ext} = \%ext;
		1147	}
		1148	}
		1149
		1150	# and now merge resources and bindings
		1151	while (my ($k, $v) = each %{ $meta{ext} }) {
		1152	#TODO: should check for extensions overriding each other
		1153	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1154	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1155	}
		1156	}
		1157
1232	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1158	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1233		1159
1234	Creates a new terminal, very similar as if you had started it with system	1160	Creates a new terminal, very similar as if you had started it with system
1235	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1161	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1236	hash which defines the environment of the new terminal.	1162	hash which defines the environment of the new terminal.
…		…
1253	}	1179	}
1254		1180
1255	=item $term->destroy	1181	=item $term->destroy
1256		1182
1257	Destroy the terminal object (close the window, free resources	1183	Destroy the terminal object (close the window, free resources
1258	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1184	etc.). Please note that urxvt will not exit as long as any event
1259	watchers (timers, io watchers) are still active.	1185	watchers (timers, io watchers) are still active.
1260		1186
1261	=item $term->exec_async ($cmd[, @args])	1187	=item $term->exec_async ($cmd[, @args])
1262		1188
1263	Works like the combination of the C<fork>/C<exec> builtins, which executes	1189	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1290	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1216	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1291		1217
1292	Here is a likely non-exhaustive list of option names, please see the	1218	Here is a likely non-exhaustive list of option names, please see the
1293	source file F</src/optinc.h> to see the actual list:	1219	source file F</src/optinc.h> to see the actual list:
1294		1220
1295	borderLess console cursorBlink cursorUnderline hold iconic insecure	1221	borderLess buffered console cursorBlink cursorUnderline hold iconic
1296	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1222	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1297	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1223	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1298	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1224	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1299	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1225	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1300	transparent tripleclickwords utmpInhibit visualBell	1226	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1227	urgentOnBell utmpInhibit visualBell
1301		1228
1302	=item $value = $term->resource ($name[, $newval])	1229	=item $value = $term->resource ($name[, $newval])
1303		1230
1304	Returns the current resource value associated with a given name and	1231	Returns the current resource value associated with a given name and
1305	optionally sets a new value. Setting values is most useful in the C<init>	1232	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1318		1245
1319	Here is a likely non-exhaustive list of resource names, not all of which	1246	Here is a likely non-exhaustive list of resource names, not all of which
1320	are supported in every build, please see the source file F</src/rsinc.h>	1247	are supported in every build, please see the source file F</src/rsinc.h>
1321	to see the actual list:	1248	to see the actual list:
1322		1249
1323	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1250	answerbackstring backgroundPixmap backspace_key blurradius
1324	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1251	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1325	display_name embed ext_bwidth fade font geometry hold iconName	1252	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1326	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1253	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1327	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8	1254	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
		1255	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1328	modifier mouseWheelScrollPage name override_redirect pastableTabs path	1256	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1329	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1257	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1330	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1258	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1331	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1259	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1332	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1260	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1333	secondaryScreen secondaryScroll shade term_name title	1261	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1334	transient_for transparent transparent_all tripleclickwords utmpInhibit	1262	term_name title transient_for transparent tripleclickwords urgentOnBell
1335	visualBell	1263	utmpInhibit visualBell
1336		1264
1337	=cut	1265	=cut
1338		1266
1339	sub resource($$;$) {	1267	sub resource($$;$) {
1340	my ($self, $name) = (shift, shift);	1268	my ($self, $name) = (shift, shift);
…		…
1347	Returns the X-Resource for the given pattern, excluding the program or	1275	Returns the X-Resource for the given pattern, excluding the program or
1348	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1276	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1349	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1277	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1350	resource with that pattern exists.	1278	resource with that pattern exists.
1351		1279
		1280	Extensions that define extra resources also need to call this method
		1281	to access their values.
		1282
		1283	If the method is called on an extension object (basically, from an
		1284	extension), then the special prefix C<%.> will be replaced by the name of
		1285	the extension and a dot, and the lone string C<%> will be replaced by the
		1286	extension name itself. This makes it possible to code extensions so you
		1287	can rename them and get a new set of commandline switches and resources
		1288	without having to change the actual code.
		1289
1352	This method should only be called during the C<on_start> hook, as there is	1290	This method should only be called during the C<on_start> hook, as there is
1353	only one resource database per display, and later invocations might return	1291	only one resource database per display, and later invocations might return
1354	the wrong resources.	1292	the wrong resources.
1355		1293
1356	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1294	=item $value = $term->x_resource_boolean ($pattern)
1357		1295
		1296	Like C<x_resource>, above, but interprets the string value as a boolean
		1297	and returns C<1> for true values, C<0> for false values and C<undef> if
		1298	the resource or option isn't specified.
		1299
		1300	You should always use this method to parse boolean resources.
		1301
		1302	=cut
		1303
		1304	sub x_resource_boolean {
		1305	my $res = &x_resource;
		1306
		1307	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1308	}
		1309
		1310	=item $success = $term->bind_action ($key, $octets)
		1311
1358	Adds a keymap translation exactly as specified via a resource. See the	1312	Adds a key binding exactly as specified via a C<keysym> resource. See the
1359	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1313	C<keysym> resource in the urxvt(1) manpage.
1360		1314
1361	=item $rend = $term->rstyle ([$new_rstyle])	1315	=item $rend = $term->rstyle ([$new_rstyle])
1362		1316
1363	Return and optionally change the current rendition. Text that is output by	1317	Return and optionally change the current rendition. Text that is output by
1364	the terminal application will use this style.	1318	the terminal application will use this style.
…		…
1372		1326
1373	=item ($row, $col) = $term->selection_beg ([$row, $col])	1327	=item ($row, $col) = $term->selection_beg ([$row, $col])
1374		1328
1375	=item ($row, $col) = $term->selection_end ([$row, $col])	1329	=item ($row, $col) = $term->selection_end ([$row, $col])
1376		1330
1377	Return the current values of the selection mark, begin or end positions,	1331	Return the current values of the selection mark, begin or end positions.
1378	and optionally set them to new values.	1332
		1333	When arguments are given, then the selection coordinates are set to
		1334	C<$row> and C<$col>, and the selection screen is set to the current
		1335	screen.
		1336
		1337	=item $screen = $term->selection_screen ([$screen])
		1338
		1339	Returns the current selection screen, and then optionally sets it.
1379		1340
1380	=item $term->selection_make ($eventtime[, $rectangular])	1341	=item $term->selection_make ($eventtime[, $rectangular])
1381		1342
1382	Tries to make a selection as set by C<selection_beg> and	1343	Tries to make a selection as set by C<selection_beg> and
1383	C<selection_end>. If C<$rectangular> is true (default: false), a	1344	C<selection_end>. If C<$rectangular> is true (default: false), a
1384	rectangular selection will be made. This is the prefered function to make	1345	rectangular selection will be made. This is the preferred function to make
1385	a selection.	1346	a selection.
1386		1347
1387	=item $success = $term->selection_grab ($eventtime)	1348	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1388		1349
1389	Try to request the primary selection text from the server (for example, as	1350	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1351	true) selection from the server. The corresponding text can be set
1390	set by the next method). No visual feedback will be given. This function	1352	with the next method. No visual feedback will be given. This function
1391	is mostly useful from within C<on_sel_grab> hooks.	1353	is mostly useful from within C<on_sel_grab> hooks.
1392		1354
1393	=item $oldtext = $term->selection ([$newtext])	1355	=item $oldtext = $term->selection ([$newtext, $clipboard])
1394		1356
1395	Return the current selection text and optionally replace it by C<$newtext>.	1357	Return the current selection (clipboard if C<$clipboard> is true) text
		1358	and optionally replace it by C<$newtext>.
		1359
		1360	=item $term->selection_clear ([$clipboard])
		1361
		1362	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1396		1363
1397	=item $term->overlay_simple ($x, $y, $text)	1364	=item $term->overlay_simple ($x, $y, $text)
1398		1365
1399	Create a simple multi-line overlay box. See the next method for details.	1366	Create a simple multi-line overlay box. See the next method for details.
1400		1367
…		…
1528	locale-specific encoding of the terminal and can contain command sequences	1495	locale-specific encoding of the terminal and can contain command sequences
1529	(escape codes) that will be interpreted.	1496	(escape codes) that will be interpreted.
1530		1497
1531	=item $term->tt_write ($octets)	1498	=item $term->tt_write ($octets)
1532		1499
1533	Write the octets given in C<$data> to the tty (i.e. as program input). To	1500	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1534	pass characters instead of octets, you should convert your strings first	1501	pass characters instead of octets, you should convert your strings first
1535	to the locale-specific encoding using C<< $term->locale_encode >>.	1502	to the locale-specific encoding using C<< $term->locale_encode >>.
		1503
		1504	=item $term->tt_write_user_input ($octets)
		1505
		1506	Like C<tt_write>, but should be used when writing strings in response to
		1507	the user pressing a key, to invoke the additional actions requested by
		1508	the user for that case (C<tt_write> doesn't do that).
		1509
		1510	The typical use case would be inside C<on_action> hooks.
		1511
		1512	=item $term->tt_paste ($octets)
		1513
		1514	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1515	CR and bracketing the data with control sequences if bracketed paste mode
		1516	is set.
1536		1517
1537	=item $old_events = $term->pty_ev_events ([$new_events])	1518	=item $old_events = $term->pty_ev_events ([$new_events])
1538		1519
1539	Replaces the event mask of the pty watcher by the given event mask. Can	1520	Replaces the event mask of the pty watcher by the given event mask. Can
1540	be used to suppress input and output handling to the pty/tty. See the	1521	be used to suppress input and output handling to the pty/tty. See the
…		…
1558		1539
1559	Adds the specified events to the vt event mask. Useful e.g. when you want	1540	Adds the specified events to the vt event mask. Useful e.g. when you want
1560	to receive pointer events all the times:	1541	to receive pointer events all the times:
1561		1542
1562	$term->vt_emask_add (urxvt::PointerMotionMask);	1543	$term->vt_emask_add (urxvt::PointerMotionMask);
		1544
		1545	=item $term->set_urgency ($set)
		1546
		1547	Enable/disable the urgency hint on the toplevel window.
1563		1548
1564	=item $term->focus_in	1549	=item $term->focus_in
1565		1550
1566	=item $term->focus_out	1551	=item $term->focus_out
1567		1552
…		…
1764	}	1749	}
1765		1750
1766	sub urxvt::line::t {	1751	sub urxvt::line::t {
1767	my ($self) = @_;	1752	my ($self) = @_;
1768		1753
1769	if (@_ > 1)	1754	if (@_ > 1) {
1770	{
1771	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1755	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1772	for $self->{beg} .. $self->{end};	1756	for $self->{beg} .. $self->{end};
1773	}	1757	}
1774		1758
1775	defined wantarray &&	1759	defined wantarray &&
1776	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1760	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1777	0, $self->{len}	1761	0, $self->{len}
1778	}	1762	}
1779		1763
1780	sub urxvt::line::r {	1764	sub urxvt::line::r {
1781	my ($self) = @_;	1765	my ($self) = @_;
1782		1766
1783	if (@_ > 1)	1767	if (@_ > 1) {
1784	{
1785	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1768	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1786	for $self->{beg} .. $self->{end};	1769	for $self->{beg} .. $self->{end};
1787	}	1770	}
1788		1771
1789	if (defined wantarray) {	1772	if (defined wantarray) {
1790	my $rend = [	1773	my $rend = [
1791	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1774	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1792	];	1775	];
…		…
1854	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1837	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1855	recent grab.	1838	recent grab.
1856		1839
1857	=item $term->ungrab	1840	=item $term->ungrab
1858		1841
1859	Calls XUngrab for the most recent grab. Is called automatically on	1842	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1860	evaluation errors, as it is better to lose the grab in the error case as	1843	evaluation errors, as it is better to lose the grab in the error case as
1861	the session.	1844	the session.
1862		1845
1863	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1846	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1864		1847
…		…
1884		1867
1885	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1868	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1886		1869
1887	=item $term->XChangeInput ($window, $add_events[, $del_events])	1870	=item $term->XChangeInput ($window, $add_events[, $del_events])
1888		1871
		1872	=item $keysym = $term->XStringToKeysym ($string)
		1873
		1874	=item $string = $term->XKeysymToString ($keysym)
		1875
1889	Various X or X-related functions. The C<$term> object only serves as	1876	Various X or X-related functions. The C<$term> object only serves as
1890	the source of the display, otherwise those functions map more-or-less	1877	the source of the display, otherwise those functions map more-or-less
1891	directory onto the X functions of the same name.	1878	directly onto the X functions of the same name.
1892		1879
1893	=back	1880	=back
1894		1881
1895	=cut	1882	=cut
1896		1883
…		…
2214		2201
2215	=back	2202	=back
2216		2203
2217	=head1 AUTHOR	2204	=head1 AUTHOR
2218		2205
2219	Marc Lehmann <pcg@goof.com>	2206	Marc Lehmann <schmorp@schmorp.de>
2220	http://software.schmorp.de/pkg/rxvt-unicode	2207	http://software.schmorp.de/pkg/rxvt-unicode
2221		2208
2222	=cut	2209	=cut
2223		2210
2224	1	2211	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.179 by root, Sat Dec 26 09:23:53 2009 UTC vs. Revision 1.242 by sf-exg, Sat Oct 11 20:46:36 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.179 by root, Sat Dec 26 09:23:53 2009 UTC vs.
Revision 1.242 by sf-exg, Sat Oct 11 20:46:36 2014 UTC