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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC vs. Revision 1.240 by sf-exg, Fri Oct 10 14:32:32 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC vs.
Revision 1.240 by sf-exg, Fri Oct 10 14:32:32 2014 UTC