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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.178 by root, Sat Dec 26 09:02:42 2009 UTC vs.
Revision 1.227 by root, Sun Mar 31 20:30:32 2013 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,
…		…
639		285
640	=item on_user_command $term, $string	286	=item on_user_command $term, $string
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 assumed to change
647	slightly in the future.	293	slightly in the future.
648		294
		295	=item on_register_command $term, $keysym, $modifiermask, $string
		296
		297	Called after parsing a keysym resource but before registering the
		298	associated binding. If this hook returns TRUE the binding is not
		299	registered. It can be used to modify a binding by calling
		300	C<register_command>.
		301
649	=item on_resize_all_windows $tern, $new_width, $new_height	302	=item on_resize_all_windows $term, $new_width, $new_height
650		303
651	Called just after the new window size has been calculated, but before	304	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	305	windows are actually being resized or hints are being set. If this hook
653	returns TRUE, setting of the window hints is being skipped.	306	returns TRUE, setting of the window hints is being skipped.
654		307
…		…
688		341
689	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
690		343
691	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
692		345
693	Called whenever the corresponding X event is received for the terminal If	346	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.	347	the hook returns true, then the event will be ignored by rxvt-unicode.
695		348
696	The event is a hash with most values as named by Xlib (see the XEvent	349	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	350	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.	351	(real, not screen-based) row and column under the mouse cursor.
699		352
…		…
709	=item on_wm_delete_window $term, $event	362	=item on_wm_delete_window $term, $event
710		363
711	Called when various types of ClientMessage events are received (all with	364	Called when various types of ClientMessage events are received (all with
712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	365	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
713		366
		367	=item on_bell $term
		368
		369	Called on receipt of a bell character.
		370
714	=back	371	=back
715		372
716	=cut	373	=cut
717		374
718	package urxvt;	375	package urxvt;
719		376
720	use utf8;	377	use utf8;
721	use strict;	378	use strict 'vars';
722	use Carp ();	379	use Carp ();
723	use Scalar::Util ();	380	use Scalar::Util ();
724	use List::Util ();	381	use List::Util ();
725		382
726	our $VERSION = 1;	383	our $VERSION = 1;
727	our $TERM;	384	our $TERM;
728	our @TERM_INIT;	385	our @TERM_INIT; # should go, prevents async I/O etc.
729	our @TERM_EXT;	386	our @TERM_EXT; # should go, prevents async I/O etc.
730	our @HOOKNAME;	387	our @HOOKNAME;
731	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
732	our %OPTION;	389	our %OPTION;
733		390
734	our $LIBDIR;	391	our $LIBDIR;
…		…
782		439
783	=over 4	440	=over 4
784		441
785	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
786		443
787	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
788	costs! The only time this is acceptable is when the terminal process	445	include a trailing newline). Avoid at all costs! The only time this
789	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
790		448
791	=item urxvt::warn $string	449	=item urxvt::warn $string
792		450
793	Calls C<rxvt_warn> with the given string which should not include a	451	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	452	newline. The module also overwrites the C<warn> builtin with a function
795	that calls this function.	453	that calls this function.
796		454
797	Using this function has the advantage that its output ends up in the	455	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.	456	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
802	=item @terms = urxvt::termlist	460	=item @terms = urxvt::termlist
803		461
804	Returns all urxvt::term objects that exist in this process, regardless of	462	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	463	whether they are started, being destroyed etc., so be careful. Only term
806	objects that have perl extensions attached will be returned (because there	464	objects that have perl extensions attached will be returned (because there
807	is no urxvt::term objet associated with others).	465	is no urxvt::term object associated with others).
808		466
809	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
810		468
811	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
812		470
…		…
855		513
856	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
857		515
858	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
859		517
860	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	518	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		519	urxvt::RS_RVid, urxvt::RS_Uline
861		520
862	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
863	underline, respectively. To enable such a style, just logically OR it into	522	underline, respectively. To enable such a style, just logically OR it into
864	the bitset.	523	the bitset.
865		524
…		…
902	};	561	};
903	}	562	}
904		563
905	no warnings 'utf8';	564	no warnings 'utf8';
906		565
		566	sub parse_resource {
		567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		568
		569	$name =~ y/-/./ if $isarg;
		570
		571	$term->scan_meta;
		572
		573	my $r = $term->{meta}{resource};
		574	keys %$r; # reste iterator
		575	while (my ($pattern, $v) = each %$r) {
		576	if (
		577	$pattern =~ /\.$/
		578	? $pattern eq substr $name, 0, length $pattern
		579	: $pattern eq $name
		580	) {
		581	$name = "$urxvt::RESCLASS.$name";
		582
		583	push @{ $term->{perl_ext_3} }, $v->[0];
		584
		585	if ($v->[1] eq "boolean") {
		586	$term->put_option_db ($name, $flag ? "true" : "false");
		587	return 1;
		588	} else {
		589	$term->put_option_db ($name, $value);
		590	return 1 + 2;
		591	}
		592	}
		593	}
		594
		595	0
		596	}
		597
		598	sub usage {
		599	my ($term, $usage_type) = @_;
		600
		601	$term->scan_meta;
		602
		603	my $r = $term->{meta}{resource};
		604
		605	for my $pattern (sort keys %$r) {
		606	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		607
		608	$desc .= " (-pe $ext)";
		609
		610	if ($usage_type == 1) {
		611	$pattern =~ y/./-/;
		612	$pattern =~ s/-$/-.../g;
		613
		614	if ($type eq "boolean") {
		615	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		616	} else {
		617	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		618	}
		619	} else {
		620	$pattern =~ s/\.$/.*/g;
		621	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		622	}
		623	}
		624	}
		625
907	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
908		627
909	sub verbose {	628	sub verbose {
910	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
911	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
…		…
923	$pkg =~ s/[^[:word:]]/_/g;	642	$pkg =~ s/[^[:word:]]/_/g;
924	$pkg = "urxvt::ext::$pkg";	643	$pkg = "urxvt::ext::$pkg";
925		644
926	verbose 3, "loading extension '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
927		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		648
928	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
929	or die "$path: $!";	650	or die "$path: $!";
930		651
931	my $source =	652	my $source =
932	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
933	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
934	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
935	. "\n};\n1";	656	. "\n};\n1";
936		657
937	eval $source	658	eval $source
…		…
947	sub invoke {	668	sub invoke {
948	local $TERM = shift;	669	local $TERM = shift;
949	my $htype = shift;	670	my $htype = shift;
950		671
951	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
953		674
954	my %ext_arg;	675	my %ext_arg;
955		676
956	{	677	{
957	my @init = @TERM_INIT;	678	my @init = @TERM_INIT;
…		…
960	my @pkg = @TERM_EXT;	681	my @pkg = @TERM_EXT;
961	@TERM_EXT = ();	682	@TERM_EXT = ();
962	$TERM->register_package ($_) for @pkg;	683	$TERM->register_package ($_) for @pkg;
963	}	684	}
964		685
		686	for (
		687	@{ delete $TERM->{perl_ext_3} },
965	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
966	if ($_ eq "default") {	690	if ($_ eq "default") {
967	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	691	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
968	} elsif (/^-(.*)$/) {	692	} elsif (/^-(.*)$/) {
969	delete $ext_arg{$1};	693	delete $ext_arg{$1};
970	} elsif (/^([^<]+)<(.*)>$/) {	694	} elsif (/^([^<]+)<(.*)>$/) {
…		…
993	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
994	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
995	if $verbosity >= 10;	719	if $verbosity >= 10;
996		720
997	for my $pkg (keys %$cb) {	721	for my $pkg (keys %$cb) {
998	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
999	$retval \|\|= $retval_;	723	$retval \|\|= $retval_;
1000		724
1001	if ($@) {	725	if ($@) {
1002	$TERM->ungrab; # better to lose the grab than the session	726	$TERM->ungrab; # better to lose the grab than the session
1003	warn $@;	727	warn $@;
…		…
1046	}	770	}
1047	}	771	}
1048	($mask, @color{qw(fg bg)}, \@failed)	772	($mask, @color{qw(fg bg)}, \@failed)
1049	}	773	}
1050		774
1051	# urxvt::term::extension
1052
1053	package urxvt::term::extension;	775	package urxvt::term::extension;
1054		776
1055	sub enable {	777	=head2 The C<urxvt::term::extension> class
1056	my ($self, %hook) = @_;
1057	my $pkg = $self->{_pkg};
1058		778
1059	while (my ($name, $cb) = each %hook) {	779	Each extension attached to a terminal object is represented by
1060	my $htype = $HOOKTYPE{uc $name};	780	a C<urxvt::term::extension> object.
1061	defined $htype
1062	or Carp::croak "unsupported hook type '$name'";
1063		781
1064	$self->set_should_invoke ($htype, +1)	782	You can use these objects, which are passed to all callbacks to store any
1065	unless exists $self->{term}{_hook}[$htype]{$pkg};	783	state related to the terminal and extension instance.
1066		784
1067	$self->{term}{_hook}[$htype]{$pkg} = $cb;	785	The methods (And data members) documented below can be called on extension
1068	}	786	objects, in addition to call methods documented for the <urxvt::term>
1069	}	787	class.
1070		788
1071	sub disable {	789	=over 4
1072	my ($self, @hook) = @_;
1073	my $pkg = $self->{_pkg};
1074		790
1075	for my $name (@hook) {	791	=item $urxvt_term = $self->{term}
1076	my $htype = $HOOKTYPE{uc $name};
1077	defined $htype
1078	or Carp::croak "unsupported hook type '$name'";
1079		792
1080	$self->set_should_invoke ($htype, -1)	793	Returns the C<urxvt::term> object associated with this instance of the
1081	if delete $self->{term}{_hook}[$htype]{$pkg};	794	extension. This member I<must not> be changed in any way.
1082	}	795
1083	}	796	=cut
1084		797
1085	our $AUTOLOAD;	798	our $AUTOLOAD;
1086		799
1087	sub AUTOLOAD {	800	sub AUTOLOAD {
1088	$AUTOLOAD =~ /:([^:]+)$/	801	$AUTOLOAD =~ /:([^:]+)$/
…		…
1101		814
1102	sub DESTROY {	815	sub DESTROY {
1103	# nop	816	# nop
1104	}	817	}
1105		818
1106	# urxvt::destroy_hook	819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1107		820
1108	sub urxvt::destroy_hook::DESTROY {	821	sub urxvt::destroy_hook::DESTROY {
1109	${$_[0]}->();	822	${$_[0]}->();
1110	}	823	}
1111		824
1112	sub urxvt::destroy_hook(&) {	825	sub urxvt::destroy_hook(&) {
1113	bless \shift, urxvt::destroy_hook::	826	bless \shift, urxvt::destroy_hook::
1114	}	827	}
		828
		829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		830
		831	Dynamically enable the given hooks (named without the C<on_> prefix) for
		832	this extension, replacing any previous hook. This is useful when you want
		833	to overwrite time-critical hooks only temporarily.
		834
		835	To install additional callbacks for the same hook, you can use the C<on>
		836	method of the C<urxvt::term> class.
		837
		838	=item $self->disable ($hook_name[, $hook_name..])
		839
		840	Dynamically disable the given hooks.
		841
		842	=cut
		843
		844	sub enable {
		845	my ($self, %hook) = @_;
		846	my $pkg = $self->{_pkg};
		847
		848	while (my ($name, $cb) = each %hook) {
		849	my $htype = $HOOKTYPE{uc $name};
		850	defined $htype
		851	or Carp::croak "unsupported hook type '$name'";
		852
		853	$self->set_should_invoke ($htype, +1)
		854	unless exists $self->{term}{_hook}[$htype]{$pkg};
		855
		856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		857	}
		858	}
		859
		860	sub disable {
		861	my ($self, @hook) = @_;
		862	my $pkg = $self->{_pkg};
		863
		864	for my $name (@hook) {
		865	my $htype = $HOOKTYPE{uc $name};
		866	defined $htype
		867	or Carp::croak "unsupported hook type '$name'";
		868
		869	$self->set_should_invoke ($htype, -1)
		870	if delete $self->{term}{_hook}[$htype]{$pkg};
		871	}
		872	}
		873
		874	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		875
		876	Similar to the C<enable> enable, but installs additional callbacks for
		877	the given hook(s) (that is, it doesn't replace existing callbacks), and
		878	returns a guard object. When the guard object is destroyed the callbacks
		879	are disabled again.
		880
		881	=cut
		882
		883	sub urxvt::extension::on_disable::DESTROY {
		884	my $disable = shift;
		885
		886	my $term = delete $disable->{""};
		887
		888	while (my ($htype, $id) = each %$disable) {
		889	delete $term->{_hook}[$htype]{$id};
		890	$term->set_should_invoke ($htype, -1);
		891	}
		892	}
		893
		894	sub on {
		895	my ($self, %hook) = @_;
		896
		897	my $term = $self->{term};
		898
		899	my %disable = ( "" => $term );
		900
		901	while (my ($name, $cb) = each %hook) {
		902	my $htype = $HOOKTYPE{uc $name};
		903	defined $htype
		904	or Carp::croak "unsupported hook type '$name'";
		905
		906	$term->set_should_invoke ($htype, +1);
		907	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		908	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		909	}
		910
		911	bless \%disable, "urxvt::extension::on_disable"
		912	}
		913
		914	=item $self->x_resource ($pattern)
		915
		916	=item $self->x_resource_boolean ($pattern)
		917
		918	These methods support an additional C<%> prefix when called on an
		919	extension object - see the description of these methods in the
		920	C<urxvt::term> class for details.
		921
		922	=cut
		923
		924	sub x_resource {
		925	my ($self, $name) = @_;
		926	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		927	$self->{term}->x_resource ($name)
		928	}
		929
		930	sub x_resource_boolean {
		931	my ($self, $name) = @_;
		932	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		933	$self->{term}->x_resource_boolean ($name)
		934	}
		935
		936	=back
		937
		938	=cut
1115		939
1116	package urxvt::anyevent;	940	package urxvt::anyevent;
1117		941
1118	=head2 The C<urxvt::anyevent> Class	942	=head2 The C<urxvt::anyevent> Class
1119		943
1120	The sole purpose of this class is to deliver an interface to the	944	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	945	C<AnyEvent> module - any module using it will work inside urxvt without
1122	further programming. The only exception is that you cannot wait on	946	further programming. The only exception is that you cannot wait on
1123	condition variables, but non-blocking condvar use is ok. What this means	947	condition variables, but non-blocking condvar use is ok.
1124	is that you cannot use blocking APIs, but the non-blocking variant should	948
1125	work.	949	In practical terms this means is that you cannot use blocking APIs, but
		950	the non-blocking variant should work.
1126		951
1127	=cut	952	=cut
1128		953
1129	our $VERSION = '5.23';	954	our $VERSION = '5.23';
1130		955
…		…
1136		961
1137	my $cb = $arg{cb};	962	my $cb = $arg{cb};
1138		963
1139	urxvt::timer	964	urxvt::timer
1140	->new	965	->new
1141	->after ($arg{after})	966	->after ($arg{after}, $arg{interval})
1142	->interval ($arg{interval})
1143	->start
1144	->cb ($argv{interval} ? $cb : sub {	967	->cb ($arg{interval} ? $cb : sub {
1145	$_[0]->stop; # need to cancel manually	968	$_[0]->stop; # need to cancel manually
1146	$cb->();	969	$cb->();
1147	})	970	})
1148	}	971	}
1149		972
…		…
1191		1014
1192	sub DESTROY {	1015	sub DESTROY {
1193	$_[0][1]->stop;	1016	$_[0][1]->stop;
1194	}	1017	}
1195		1018
		1019	# only needed for AnyEvent < 6 compatibility
1196	sub one_event {	1020	sub one_event {
1197	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1021	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1198	}	1022	}
1199		1023
1200	package urxvt::term;	1024	package urxvt::term;
…		…
1215	urxvt::verbose 6, "register package $pkg to $self";	1039	urxvt::verbose 6, "register package $pkg to $self";
1216		1040
1217	@{"$pkg\::ISA"} = urxvt::term::extension::;	1041	@{"$pkg\::ISA"} = urxvt::term::extension::;
1218		1042
1219	my $proxy = bless {	1043	my $proxy = bless {
1220	_pkg => $pkg,	1044	_pkg => $pkg,
		1045	_name => ${"$pkg\::_NAME"}, # hackish
1221	argv => $argv,	1046	argv => $argv,
1222	}, $pkg;	1047	}, $pkg;
1223	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
1224		1049
1225	$self->{_pkg}{$pkg} = $proxy;	1050	$self->{_pkg}{$pkg} = $proxy;
1226		1051
…		…
1229	$proxy->enable ($name => $ref);	1054	$proxy->enable ($name => $ref);
1230	}	1055	}
1231	}	1056	}
1232	}	1057	}
1233		1058
		1059	sub perl_libdirs {
		1060	map { split /:/ }
		1061	$_[0]->resource ("perl_lib"),
		1062	$ENV{URXVT_PERL_LIB},
		1063	"$ENV{HOME}/.urxvt/ext",
		1064	"$LIBDIR/perl"
		1065	}
		1066
		1067	sub scan_meta {
		1068	my ($self) = @_;
		1069	my @libdirs = perl_libdirs $self;
		1070
		1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1072
		1073	my %meta;
		1074
		1075	$self->{meta_libdirs} = join "\x00", @libdirs;
		1076	$self->{meta} = \%meta;
		1077
		1078	for my $dir (reverse @libdirs) {
		1079	opendir my $fh, $dir
		1080	or next;
		1081	for my $ext (readdir $fh) {
		1082	$ext !~ /^\./
		1083	and open my $fh, "<", "$dir/$ext"
		1084	or next;
		1085
		1086	while (<$fh>) {
		1087	if (/^#:META:X_RESOURCE:(.*)/) {
		1088	my ($pattern, $type, $desc) = split /:/, $1;
		1089	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1090	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1091	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1092	} else {
		1093	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1094	}
		1095	} elsif (/^\s*(?:#\|$)/) {
		1096	# skip other comments and empty lines
		1097	} else {
		1098	last; # stop parsing on first non-empty non-comment line
		1099	}
		1100	}
		1101	}
		1102	}
		1103	}
		1104
1234	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1105	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1235		1106
1236	Creates a new terminal, very similar as if you had started it with system	1107	Creates a new terminal, very similar as if you had started it with system
1237	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1108	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1238	hash which defines the environment of the new terminal.	1109	hash which defines the environment of the new terminal.
…		…
1255	}	1126	}
1256		1127
1257	=item $term->destroy	1128	=item $term->destroy
1258		1129
1259	Destroy the terminal object (close the window, free resources	1130	Destroy the terminal object (close the window, free resources
1260	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1131	etc.). Please note that urxvt will not exit as long as any event
1261	watchers (timers, io watchers) are still active.	1132	watchers (timers, io watchers) are still active.
1262		1133
1263	=item $term->exec_async ($cmd[, @args])	1134	=item $term->exec_async ($cmd[, @args])
1264		1135
1265	Works like the combination of the C<fork>/C<exec> builtins, which executes	1136	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1292	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1163	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1293		1164
1294	Here is a likely non-exhaustive list of option names, please see the	1165	Here is a likely non-exhaustive list of option names, please see the
1295	source file F</src/optinc.h> to see the actual list:	1166	source file F</src/optinc.h> to see the actual list:
1296		1167
1297	borderLess console cursorBlink cursorUnderline hold iconic insecure	1168	borderLess buffered console cursorBlink cursorUnderline hold iconic
1298	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1169	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1299	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1170	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1300	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1171	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1301	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1172	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1302	transparent tripleclickwords utmpInhibit visualBell	1173	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1174	urgentOnBell utmpInhibit visualBell
1303		1175
1304	=item $value = $term->resource ($name[, $newval])	1176	=item $value = $term->resource ($name[, $newval])
1305		1177
1306	Returns the current resource value associated with a given name and	1178	Returns the current resource value associated with a given name and
1307	optionally sets a new value. Setting values is most useful in the C<init>	1179	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1320		1192
1321	Here is a likely non-exhaustive list of resource names, not all of which	1193	Here is a likely non-exhaustive list of resource names, not all of which
1322	are supported in every build, please see the source file F</src/rsinc.h>	1194	are supported in every build, please see the source file F</src/rsinc.h>
1323	to see the actual list:	1195	to see the actual list:
1324		1196
1325	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1197	answerbackstring backgroundPixmap backspace_key blurradius
1326	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1198	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1327	display_name embed ext_bwidth fade font geometry hold iconName	1199	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1328	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1200	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1329	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8	1201	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
		1202	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1330	modifier mouseWheelScrollPage name override_redirect pastableTabs path	1203	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1331	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1204	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1332	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1205	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1333	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1206	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1334	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1207	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1335	secondaryScreen secondaryScroll shade term_name title	1208	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1336	transient_for transparent transparent_all tripleclickwords utmpInhibit	1209	term_name title transient_for transparent tripleclickwords urgentOnBell
1337	visualBell	1210	utmpInhibit visualBell
1338		1211
1339	=cut	1212	=cut
1340		1213
1341	sub resource($$;$) {	1214	sub resource($$;$) {
1342	my ($self, $name) = (shift, shift);	1215	my ($self, $name) = (shift, shift);
…		…
1349	Returns the X-Resource for the given pattern, excluding the program or	1222	Returns the X-Resource for the given pattern, excluding the program or
1350	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1223	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1351	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1224	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1352	resource with that pattern exists.	1225	resource with that pattern exists.
1353		1226
		1227	Extensions that define extra resource or command line arguments also need
		1228	to call this method to access their values.
		1229
		1230	If the method is called on an extension object (basically, from an
		1231	extension), then the special prefix C<%.> will be replaced by the name of
		1232	the extension and a dot, and the lone string C<%> will be replaced by the
		1233	extension name itself. This makes it possible to code extensions so you
		1234	can rename them and get a new set of commandline switches and resources
		1235	without having to change the actual code.
		1236
1354	This method should only be called during the C<on_start> hook, as there is	1237	This method should only be called during the C<on_start> hook, as there is
1355	only one resource database per display, and later invocations might return	1238	only one resource database per display, and later invocations might return
1356	the wrong resources.	1239	the wrong resources.
1357		1240
1358	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1241	=item $value = $term->x_resource_boolean ($pattern)
1359		1242
		1243	Like C<x_resource>, above, but interprets the string value as a boolean
		1244	and returns C<1> for true values, C<0> for false values and C<undef> if
		1245	the resource or option isn't specified.
		1246
		1247	You should always use this method to parse boolean resources.
		1248
		1249	=cut
		1250
		1251	sub x_resource_boolean {
		1252	my $res = &x_resource;
		1253
		1254	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1255	}
		1256
		1257	=item $success = $term->parse_keysym ($key, $octets)
		1258
1360	Adds a keymap translation exactly as specified via a resource. See the	1259	Adds a key binding exactly as specified via a resource. See the
1361	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1260	C<keysym> resource in the urxvt(1) manpage.
		1261
		1262	=item $term->register_command ($keysym, $modifiermask, $string)
		1263
		1264	Adds a key binding. This is a lower level api compared to
		1265	C<parse_keysym>, as it expects a parsed key description, and can be
		1266	used only inside either the C<on_init> hook, to add a binding, or the
		1267	C<on_register_command> hook, to modify a parsed binding.
1362		1268
1363	=item $rend = $term->rstyle ([$new_rstyle])	1269	=item $rend = $term->rstyle ([$new_rstyle])
1364		1270
1365	Return and optionally change the current rendition. Text that is output by	1271	Return and optionally change the current rendition. Text that is output by
1366	the terminal application will use this style.	1272	the terminal application will use this style.
…		…
1374		1280
1375	=item ($row, $col) = $term->selection_beg ([$row, $col])	1281	=item ($row, $col) = $term->selection_beg ([$row, $col])
1376		1282
1377	=item ($row, $col) = $term->selection_end ([$row, $col])	1283	=item ($row, $col) = $term->selection_end ([$row, $col])
1378		1284
1379	Return the current values of the selection mark, begin or end positions,	1285	Return the current values of the selection mark, begin or end positions.
1380	and optionally set them to new values.	1286
		1287	When arguments are given, then the selection coordinates are set to
		1288	C<$row> and C<$col>, and the selection screen is set to the current
		1289	screen.
		1290
		1291	=item $screen = $term->selection_screen ([$screen])
		1292
		1293	Returns the current selection screen, and then optionally sets it.
1381		1294
1382	=item $term->selection_make ($eventtime[, $rectangular])	1295	=item $term->selection_make ($eventtime[, $rectangular])
1383		1296
1384	Tries to make a selection as set by C<selection_beg> and	1297	Tries to make a selection as set by C<selection_beg> and
1385	C<selection_end>. If C<$rectangular> is true (default: false), a	1298	C<selection_end>. If C<$rectangular> is true (default: false), a
1386	rectangular selection will be made. This is the prefered function to make	1299	rectangular selection will be made. This is the preferred function to make
1387	a selection.	1300	a selection.
1388		1301
1389	=item $success = $term->selection_grab ($eventtime)	1302	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1390		1303
1391	Try to request the primary selection text from the server (for example, as	1304	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1305	true) selection from the server. The corresponding text can be set
1392	set by the next method). No visual feedback will be given. This function	1306	with the next method. No visual feedback will be given. This function
1393	is mostly useful from within C<on_sel_grab> hooks.	1307	is mostly useful from within C<on_sel_grab> hooks.
1394		1308
1395	=item $oldtext = $term->selection ([$newtext])	1309	=item $oldtext = $term->selection ([$newtext, $clipboard])
1396		1310
1397	Return the current selection text and optionally replace it by C<$newtext>.	1311	Return the current selection (clipboard if C<$clipboard> is true) text
		1312	and optionally replace it by C<$newtext>.
		1313
		1314	=item $term->selection_clear ([$clipboard])
		1315
		1316	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1398		1317
1399	=item $term->overlay_simple ($x, $y, $text)	1318	=item $term->overlay_simple ($x, $y, $text)
1400		1319
1401	Create a simple multi-line overlay box. See the next method for details.	1320	Create a simple multi-line overlay box. See the next method for details.
1402		1321
…		…
1530	locale-specific encoding of the terminal and can contain command sequences	1449	locale-specific encoding of the terminal and can contain command sequences
1531	(escape codes) that will be interpreted.	1450	(escape codes) that will be interpreted.
1532		1451
1533	=item $term->tt_write ($octets)	1452	=item $term->tt_write ($octets)
1534		1453
1535	Write the octets given in C<$data> to the tty (i.e. as program input). To	1454	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1536	pass characters instead of octets, you should convert your strings first	1455	pass characters instead of octets, you should convert your strings first
1537	to the locale-specific encoding using C<< $term->locale_encode >>.	1456	to the locale-specific encoding using C<< $term->locale_encode >>.
		1457
		1458	=item $term->tt_paste ($octets)
		1459
		1460	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1461	CR and bracketing the data with control sequences if bracketed paste mode
		1462	is set.
1538		1463
1539	=item $old_events = $term->pty_ev_events ([$new_events])	1464	=item $old_events = $term->pty_ev_events ([$new_events])
1540		1465
1541	Replaces the event mask of the pty watcher by the given event mask. Can	1466	Replaces the event mask of the pty watcher by the given event mask. Can
1542	be used to suppress input and output handling to the pty/tty. See the	1467	be used to suppress input and output handling to the pty/tty. See the
…		…
1560		1485
1561	Adds the specified events to the vt event mask. Useful e.g. when you want	1486	Adds the specified events to the vt event mask. Useful e.g. when you want
1562	to receive pointer events all the times:	1487	to receive pointer events all the times:
1563		1488
1564	$term->vt_emask_add (urxvt::PointerMotionMask);	1489	$term->vt_emask_add (urxvt::PointerMotionMask);
		1490
		1491	=item $term->set_urgency ($set)
		1492
		1493	Enable/disable the urgency hint on the toplevel window.
1565		1494
1566	=item $term->focus_in	1495	=item $term->focus_in
1567		1496
1568	=item $term->focus_out	1497	=item $term->focus_out
1569		1498
…		…
1766	}	1695	}
1767		1696
1768	sub urxvt::line::t {	1697	sub urxvt::line::t {
1769	my ($self) = @_;	1698	my ($self) = @_;
1770		1699
1771	if (@_ > 1)	1700	if (@_ > 1) {
1772	{
1773	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1701	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1774	for $self->{beg} .. $self->{end};	1702	for $self->{beg} .. $self->{end};
1775	}	1703	}
1776		1704
1777	defined wantarray &&	1705	defined wantarray &&
1778	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1706	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1779	0, $self->{len}	1707	0, $self->{len}
1780	}	1708	}
1781		1709
1782	sub urxvt::line::r {	1710	sub urxvt::line::r {
1783	my ($self) = @_;	1711	my ($self) = @_;
1784		1712
1785	if (@_ > 1)	1713	if (@_ > 1) {
1786	{
1787	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1714	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1788	for $self->{beg} .. $self->{end};	1715	for $self->{beg} .. $self->{end};
1789	}	1716	}
1790		1717
1791	if (defined wantarray) {	1718	if (defined wantarray) {
1792	my $rend = [	1719	my $rend = [
1793	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1720	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1794	];	1721	];
…		…
1856	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1783	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1857	recent grab.	1784	recent grab.
1858		1785
1859	=item $term->ungrab	1786	=item $term->ungrab
1860		1787
1861	Calls XUngrab for the most recent grab. Is called automatically on	1788	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1862	evaluation errors, as it is better to lose the grab in the error case as	1789	evaluation errors, as it is better to lose the grab in the error case as
1863	the session.	1790	the session.
1864		1791
1865	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1792	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1866		1793
…		…
1886		1813
1887	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1814	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1888		1815
1889	=item $term->XChangeInput ($window, $add_events[, $del_events])	1816	=item $term->XChangeInput ($window, $add_events[, $del_events])
1890		1817
		1818	=item $keysym = $term->XStringToKeysym ($string)
		1819
		1820	=item $string = $term->XKeysymToString ($keysym)
		1821
1891	Various X or X-related functions. The C<$term> object only serves as	1822	Various X or X-related functions. The C<$term> object only serves as
1892	the source of the display, otherwise those functions map more-or-less	1823	the source of the display, otherwise those functions map more-or-less
1893	directory onto the X functions of the same name.	1824	directly onto the X functions of the same name.
1894		1825
1895	=back	1826	=back
1896		1827
1897	=cut	1828	=cut
1898		1829
…		…
2055		1986
2056	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1987	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2057		1988
2058	Set the callback to be called when the timer triggers.	1989	Set the callback to be called when the timer triggers.
2059		1990
2060	=item $tstamp = $timer->at
2061
2062	Return the time this watcher will fire next.
2063
2064	=item $timer = $timer->set ($tstamp)	1991	=item $timer = $timer->set ($tstamp[, $interval])
2065		1992
2066	Set the time the event is generated to $tstamp.	1993	Set the time the event is generated to $tstamp (and optionally specifies a
		1994	new $interval).
2067		1995
2068	=item $timer = $timer->interval ($interval)	1996	=item $timer = $timer->interval ($interval)
2069		1997
2070	Normally (and when C<$interval> is C<0>), the timer will automatically	1998	By default (and when C<$interval> is C<0>), the timer will automatically
2071	stop after it has fired once. If C<$interval> is non-zero, then the timer	1999	stop after it has fired once. If C<$interval> is non-zero, then the timer
2072	is automatically rescheduled at the given intervals.	2000	is automatically rescheduled at the given intervals.
2073		2001
2074	=item $timer = $timer->start	2002	=item $timer = $timer->start
2075		2003
2076	Start the timer.	2004	Start the timer.
2077		2005
2078	=item $timer = $timer->start ($tstamp)	2006	=item $timer = $timer->start ($tstamp[, $interval])
2079		2007
2080	Set the event trigger time to C<$tstamp> and start the timer.	2008	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2009	also replaces the interval.
2081		2010
2082	=item $timer = $timer->after ($delay)	2011	=item $timer = $timer->after ($delay[, $interval])
2083		2012
2084	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2013	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2085		2014
2086	=item $timer = $timer->stop	2015	=item $timer = $timer->stop
2087		2016
…		…
2218		2147
2219	=back	2148	=back
2220		2149
2221	=head1 AUTHOR	2150	=head1 AUTHOR
2222		2151
2223	Marc Lehmann <pcg@goof.com>	2152	Marc Lehmann <schmorp@schmorp.de>
2224	http://software.schmorp.de/pkg/rxvt-unicode	2153	http://software.schmorp.de/pkg/rxvt-unicode
2225		2154
2226	=cut	2155	=cut
2227		2156
2228	1	2157	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.178 by root, Sat Dec 26 09:02:42 2009 UTC vs. Revision 1.227 by root, Sun Mar 31 20:30:32 2013 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.178 by root, Sat Dec 26 09:02:42 2009 UTC vs.
Revision 1.227 by root, Sun Mar 31 20:30:32 2013 UTC